Skip to content

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jan 11, 2021

Summary

This PR adds quick start videos to the Observability Guide:

Screen Shot 2021-01-11 at 9 01 19 AM

Notes

  • The first video offers an overview of all three videos, and the subsequent videos start with "Step x", so it doesn't seem like a good user experience to split the videos up (unless they were all split onto the same page).
  • I think the videos can replace the screenshots we have on each of these pages as you don't need to hit play to see the thumbnails. I wonder if we might be able to improve the APM thumbnail though – it's a bit... boring? See what I mean here, then compare with a screenshot we have here or here.

Related issues

For https://github.com/elastic/observability-docs/issues/323.

@bmorelli25 bmorelli25 requested review from a team and melvynator January 11, 2021 17:05
@bmorelli25 bmorelli25 self-assigned this Jan 11, 2021
@ghost
Copy link

ghost commented Jan 11, 2021

A docs preview will be available soon:
- HTML diff
- Observability guide

Copy link
Contributor

@dedemorton dedemorton left a 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?

@dedemorton
Copy link
Contributor

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.

@melvynator
Copy link
Contributor

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?

One question I have is around versioning. I assume that we will maintain old versions of the videos to support older docs?

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.

@melvynator
Copy link
Contributor

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"

@dedemorton
Copy link
Contributor

We don't maintain old videos. The newer version erases the older version.

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.

@melvynator
Copy link
Contributor

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.

@bmorelli25
Copy link
Member Author

We can change the thumbnail for APM with something more exciting in the 7.11 release. Will that be ok?

Yes, that works I think.

it's not going to be a great experience if the videos show functionality that doesn't exist in that version.

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.

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 if (branch == current) show video? Let me play around with it.

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"

I initially had added a header similar to this, but it felt too disconnected from the rest of the content.

@EamonnTP
Copy link
Contributor

Loving these updates!

@bmorelli25
Copy link
Member Author

Blocked while we figure out a way to conditionally show videos in current. Thread in #obs-docs.

@bmorelli25
Copy link
Member Author

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.

@bmorelli25 bmorelli25 merged commit b9dad3e into elastic:master Jan 13, 2021
@bmorelli25 bmorelli25 deleted the add-vids branch January 13, 2021 01:27
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Jan 13, 2021
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Jan 13, 2021
bmorelli25 added a commit to bmorelli25/observability-docs that referenced this pull request Jan 13, 2021
bmorelli25 added a commit that referenced this pull request Jan 13, 2021
bmorelli25 added a commit that referenced this pull request Jan 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants