-
Notifications
You must be signed in to change notification settings - Fork 40
Adds video guidance to syntax ref guide #3253
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
Merged
+61
−0
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Videos | ||
|
|
||
| Videos can supplement documentation to demonstrate features, workflows, or complex procedures. Embed videos using standard Markdown link and image syntax. | ||
|
|
||
| :::{important} | ||
| Video link URLs must use **lowercase characters only**. Mixed-case URLs cause build failures in integrations documentation. | ||
| ::: | ||
|
|
||
| ## Elastic-hosted videos (recommended) | ||
|
|
||
| For Elastic-hosted videos on `videos.elastic.co`, use a clickable thumbnail that links to the video. This displays a preview image that readers can click to watch the video. | ||
|
|
||
| ```markdown | ||
| [](https://videos.elastic.co/watch/VIDEO_ID?) | ||
| ``` | ||
|
|
||
| **Example:** | ||
|
|
||
| ```markdown | ||
| [](https://videos.elastic.co/watch/eT92arEbpRddmSM4JeyzdX?) | ||
| ``` | ||
|
|
||
| This renders as a clickable thumbnail image. When clicked, it opens the video on `videos.elastic.co`. | ||
|
|
||
| ### Finding the video ID | ||
|
|
||
| The video ID is the alphanumeric string in the Vidyard URL. For example, in `https://videos.elastic.co/watch/eT92arEbpRddmSM4JeyzdX`, the video ID is `eT92arEbpRddmSM4JeyzdX`. | ||
|
|
||
| Use this same ID for both: | ||
| - The thumbnail URL: `https://play.vidyard.com/VIDEO_ID.jpg` | ||
| - The video URL: `https://videos.elastic.co/watch/VIDEO_ID?` | ||
|
|
||
| ## YouTube videos | ||
|
|
||
| For YouTube videos, use a simple text link: | ||
|
|
||
| ```markdown | ||
| [Video title](https://www.youtube.com/watch?v=VIDEO_ID) | ||
| ``` | ||
|
|
||
| **Example:** | ||
|
|
||
| ```markdown | ||
| Refer to the [Threadpool Rejections video](https://www.youtube.com/watch?v=auZJRXoAVpI) for a troubleshooting walkthrough. | ||
| ``` | ||
|
|
||
| ## Best practices | ||
|
|
||
| **DO:** | ||
|
|
||
| - ✅ Introduce videos with context, such as "The following video demonstrates these steps (click to watch)." | ||
| - ✅ Use descriptive alt text that explains the video content | ||
| - ✅ Use lowercase characters in all video URLs | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
| - ✅ Use Elastic-hosted videos on `videos.elastic.co` when available | ||
|
|
||
| **DON'T:** | ||
|
|
||
| - ❌ Use mixed-case characters in video URLs—this causes build failures for integrations | ||
| - ❌ Rely solely on videos for critical information — always provide text alternatives | ||
| - ❌ Embed videos directly in the page—use clickable thumbnails instead | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.