-
Notifications
You must be signed in to change notification settings - Fork 175
docs: Add quickstart videos #324
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
Conversation
|
A docs preview will be available soon: |
dedemorton
left a comment
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.
LGTM!
This works really well!
One question I have is around versioning. I assume that we will maintain old versions of the videos to support older docs?
|
Another thought: To address the problem you describe in your notes, would it make sense to show "related video" links below the video? I think having the quick start on the individual pages is a lot better for folks who skip the overview. I wonder if the videos can be tweaked at some point to be more standalone. |
|
I really like it! It looks great! We can change the thumbnail for APM with something more exciting in the 7.11 release. Will that be ok?
We don't maintain old videos. The newer version erases the older version. At the same time, the videos are really focusing on getting started with the cloud. As the cloud UI changes it will make older videos irrelevant/deprecated. |
|
I have one thought with regards to your 2 points above @dedemorton. Maybe we should make a clearer distinction between the video and the text by adding some small title like: "Learn how to get get started with log monitoring in the cloud" |
Then we'll need to figure out how to handle the video links when we release a new version. I might be overthinking this a little, but if at sometime in the future users are on an older version (maybe their org is slow to upgrade), it's not going to be a great experience if the videos show functionality that doesn't exist in that version. @melvynator At the very least, we should add something to indicate that the video applies to the latest released version. Otherwise, users might see something in the video and get really frustrated when they can't figure out how to do it from reading the docs. |
|
If you think a note can do it I will be happy with that, we can also display the video only on master and the latest version if you think that would be giving a better experience. |
Yes, that works I think.
Hmm. I had assumed old videos would not be overwritten. I wonder if we can work around this with attributes in the docs? Something like
I initially had added a header similar to this, but it felt too disconnected from the rest of the content. |
|
Loving these updates! |
|
Blocked while we figure out a way to conditionally show videos in |
|
Going to merge and backport this as-is so we can get the videos up. I'll follow-up with a new PR that conditionally shows a screenshot or a video depending on the doc version. |
Summary
This PR adds quick start videos to the Observability Guide:
Notes
Related issues
For https://github.com/elastic/observability-docs/issues/323.