diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2019-06-27 16:40:47 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2019-06-27 16:40:47 +0000 |
| commit | c001513178c1f668e422d428abcd756fca8dbb3c (patch) | |
| tree | 7910e7dccacc2aa47581d96141a02b5b4416d556 | |
| parent | 71d0da4846ec8dc4eac2f54889962a100fbd946b (diff) | |
| download | gitlab-ce-docs-video-style.tar.gz | |
Video instruction editsdocs-video-style
| -rw-r--r-- | doc/development/documentation/styleguide.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 0d40bbbcf2f..b6771177c82 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -467,8 +467,8 @@ Do not upload videos to the product repositories. [Link](#link-to-video) or [emb ### Link to video -To link them out, use a YouTube icon indicating a video, so that anyone -can quickly and easily scan the page for videos before reading: +To link out to a video, include a YouTube icon so that readers can +quickly and easily scan the page for videos before reading: ```md <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> @@ -483,9 +483,9 @@ You can link any up-to-date video that is useful to the GitLab user. GitLab docs (docs.gitlab.com) support embedded videos. -You can only from embed videos from -[GitLab's official YouTube account](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg). For videos from other sources, -[link](#link-to-video) them instead. +You can only embed videos from +[GitLab's official YouTube account](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg). +For videos from other sources, [link](#link-to-video) them instead. In most cases, it is better to [link to video](#link-to-video) instead, because an embed takes up a lot of space on the page and can be distracting @@ -499,11 +499,11 @@ you have your MR reviewed and approved by a technical writer. (don't remove or add any spaces, etc). 1. On YouTube, visit the video URL you want to display. Copy the regular URL from your browser (`https://www.youtube.com/watch?v=VIDEO-ID`) - and replace the video title and link in the `<div class="video-fallback">`. -1. On YouTube, click on "Share", then "Embed". + and replace the video title and link in the line under `<div class="video-fallback">`. +1. On YouTube, click **Share**, then **Embed**. 1. Copy the `<iframe>` source (`src`) **URL only** (`https://www.youtube.com/embed/VIDEO-ID`), - and paste it replacing the content of the `src` field in the + and paste it, replacing the content of the `src` field in the `iframe` tag. ```html |