-
Notifications
You must be signed in to change notification settings - Fork 926
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
[Ready] Add video embeds of course to docs #3542
Conversation
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Hmm, I've just checked this and it's not responsive to mobile (well not to iPhone 13 mobile safari). That's not ideal. The
|
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Added @tynandebold to reviewer list to confirm that the best way to make including a youtube embed and making it responsive to screen size is to use a % size in the embed. Tynan, I know you're probably not familiar with the sphinx extension itself but I'm assuming using relative width is standard practice in front-end code? |
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.
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.
Tynan, I know you're probably not familiar with the sphinx extension itself but I'm assuming using relative width is standard practice in front-end code?
This is correct, or a percentage width, to be precise. It seems like the extension is handling all of that? It looks really good to me.
Approving with one small comment about the 90% width.
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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.
Left a few comments! Overall I think this is a great start, don't think we have to complicate it much more
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
…into add-video-embeds
Description
Added a sphinx extension to embed youtube video into the docs
Added some video into the early parts of the docs (introduction and spaceflights tutorial)
Take a look at e.g. https://kedro--3542.org.readthedocs.build/en/3542/tutorial/spaceflights_tutorial.html for how I have done it.
Development notes
Rebuilt and inspected but I need to see what this looks like on mobile.
Also @noklam @astrojuanlu are there any videos in particular that you want to include? Please let me know where you want them added? Some are quite difficult to place because the video doesn't totally match up to the way the tutorial explains things (the notebook usage at the start is not linear with the narrative we use in the text for spaceflights). Happy for you to just drop in the videos where you think they best fit -- you'll see the syntax and it's very straightforward. Best to have a consistent "Watch the video" subhead before you include the video too.
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-by
line in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.md
file