Skip to content
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

How to link from docs to videos? #4250

Open
willmcgugan opened this issue Mar 3, 2024 · 2 comments
Open

How to link from docs to videos? #4250

willmcgugan opened this issue Mar 3, 2024 · 2 comments

Comments

@willmcgugan
Copy link
Collaborator

@rodrigogiraoserrao has done a fantastic job with instructional videos on our YT channel.

I wonder if we can promote these via the docs more. A simple link may go overlooked, so I'm wondering if there is a tasteful way of pushing the YT a bit more. Something short of embedding a video player.

Perhaps a thumbnail in a callout?

This is a meta issue to request suggestions for how this should be done (add to comments).

@TomJGooding
Copy link
Contributor

TomJGooding commented Mar 4, 2024

Something short of embedding a video player.

Perhaps a thumbnail in a callout?

Why not embed the video, especially as a thumbnail would take up a similar amount of space anyway?

image

Example tutorial.md diff
diff --git a/docs/tutorial.md b/docs/tutorial.md
index ce7ed15d..bf343e8e 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -17,7 +17,9 @@ By the end of this page you should have a solid understanding of app development
 
 ## Video series
 
-This tutorial has an accompanying [video series](https://www.youtube.com/playlist?list=PLHhDR_Q5Me1MxO4LmfzMNNQyKfwa275Qe) which covers the same content.
+This tutorial has an accompanying [video series](https://www.youtube.com/playlist?list=PLHhDR_Q5Me1MxO4LmfzMNNQyKfwa275Qe) which covers the same content:
+
+[![A YouTube video link](https://img.youtube.com/vi/kpOBRI56GXM/0.jpg)](https://www.youtube.com/playlist?list=PLHhDR_Q5Me1MxO4LmfzMNNQyKfwa275Qe)
 
 ## Stopwatch Application

@rodrigogiraoserrao
Copy link
Contributor

Tom's suggestion makes sense in places like the stopwatch tutorial where there's almost a 1:1 correspondence between the written docs and the videos.
In many other places, I've just recorded random bits & bobs...

Other things we can do:

  • add a fairly discrete “Watch our short video about this” next to topics covered in videos as well;
  • for the reactivity guide (and possibly other guides in the future) make sure the topic playlist covers everything and then add a similar thumbnail to the playlist saying “This guide has an accompanying video series here:”

(For reference, here's the textual reactivity playlist: https://www.youtube.com/playlist?list=PLHhDR_Q5Me1POyvjxq0lupFbrUrJeWTAY)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants