-
Notifications
You must be signed in to change notification settings - Fork 807
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
resolves #79 by adding the following to the existing documentation: #485
Conversation
jaredmorgs
commented
Jan 27, 2016
- A paragraph describing the advantages of using a hosted video service over local video files.
- The addition of a link to the Mozilla Developer docs on supported video formats.
- whitespace between paragraphs in YouTube/Vimeo section to improve readability.
- A paragraph describing the advantages of using a hosted video service over local video files. - The addition of a link to the Mozilla Developer docs on supported video formats. - whitespace between paragraphs in YouTube/Vimeo section to improve readability.
While Asciidoctor supports many popular video formats, their support in browsers is a constantly changing landscape. | ||
|
||
.A note about serving video in browsers | ||
Wherever possible, you should use a video hosting service like YouTube or Vimeo to serve videos in online documentation formats. These services specialize in serving video in-browser, with the lowest latency possible given hardware, software, and network capabilities of the device viewing the video. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really like the phrasing here. I have two small suggestions.
Instead of "serving video in-browser", I'd prefer "streaming optimized video to the browser"
Also, could you use the sentence-per-line convention? After "online documentation formats." use a newline instead of a space. It will look like this:
... in online documentation formats.
These services specialize in...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh, so that's the explanation for the pattern I'm seeing in the user
guide. I thought you just decided not to put whitespace between what looked
like terse paragraphs.
Another one for #468 ;)
On Thu, 28 Jan 2016 at 04:47 Dan Allen [email protected] wrote:
In docs/_includes/video.adoc
#485 (comment)
:@@ -6,6 +6,14 @@ Included in:
The
video
macro supports displaying videos stored relatively as well as externally.+While Asciidoctor supports many popular video formats, their support in browsers is a constantly changing landscape.
+
+.A note about serving video in browsers
+Wherever possible, you should use a video hosting service like YouTube or Vimeo to serve videos in online documentation formats. These services specialize in serving video in-browser, with the lowest latency possible given hardware, software, and network capabilities of the device viewing the video.I really like the phrasing here. I have two small suggestions.
Instead of "serving video in-browser", I'd prefer "streaming optimized
video to the browser"Also, could you use the sentence-per-line convention? After "online
documentation formats." use a newline instead of a space. It will look like
this:... in online documentation formats.
These services specialize in...—
Reply to this email directly or view it on GitHub
https://github.com/asciidoctor/asciidoctor.org/pull/485/files#r51029601.
Sent from Mobile.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all comments incorporated. I'll push the minor fixes up now.
- A paragraph describing the advantages of using a hosted video service over local video files. - The addition of a link to the Mozilla Developer docs on supported video formats. - whitespace between paragraphs in YouTube/Vimeo section to improve readability.
into issue-79 * 'issue-79' of https://github.com/jaredmorgs/asciidoctor.org: resolves #79 by adding the following to the existing documentation:
Eff you SourceTree... |
Merged as 7298fd1. Thanks @jaredmorgs! |