add a proper tutorial on adding slides #4620
Conversation
| - shiltemann | ||
| --- | ||
|
|
||
| Once we have set up the infrastructure, we are ready to write a slide deck. |
There was a problem hiding this comment.
Should we put a requirement first (e.g. Running the GTN website locally or Running the GTN website online using GitPod)?
| > | ||
| {: .agenda} | ||
|
|
||
| The tutorial's content should be placed in the file `slides.html`. Its syntax and structure are simple, and will have the following structure: |
There was a problem hiding this comment.
It could be mentioned that the file should be in the tutorial folder.
There was a problem hiding this comment.
If they want to create slides only, we should add that they should create the tutorial folder first
| The `slides.html` needs to start with some metadata at the top: | ||
|
|
||
| - `layout: tutorial_slides`: please keep the default unless | ||
| - `title`: title of the tutorial (it will appear on the tutorial page and the topic page) |
There was a problem hiding this comment.
What happens if the title of the slide deck is different from the title in a tutorial.md?
There was a problem hiding this comment.
there is a resolution process which prefers the tutorial's title for the material, or the slide's if the tutorial is not present.
it is not an optimal solution, but as long as tutorial + slides are mixed as a "material", I do not think we can find a better one.
| The `slides.html` needs to start with some metadata at the top: | ||
|
|
||
| - `layout: tutorial_slides`: please keep the default unless | ||
| - `title`: title of the tutorial (it will appear on the tutorial page and the topic page) |
There was a problem hiding this comment.
Should we say "tutorial" here or something else to point out to the slides?
There was a problem hiding this comment.
definitely not, you're right, it should say slides.
| - userZ | ||
| ``` | ||
|
|
||
| To define a funding body in the `CONTRIBUTORS.yaml` there are a few extra fields available: |
There was a problem hiding this comment.
| To define a funding body in the `CONTRIBUTORS.yaml` there are a few extra fields available: | |
| To define a funding body in the `FUNDERS.yaml` there are a few extra fields available: |
|
|
||
| Please see the [associated slide deck]({% link topics/contributing/tutorials/create-new-tutorial-slides/slides.html %}) for details on the formatting commands available. In general the markdown you already know will continue to work, but there are additional slide formatting commands available (e.g. `.pull-left[]` for classic two column layouts.) | ||
|
|
||
| ## Automated Video Recordings |
There was a problem hiding this comment.
I would move this section after the Content section
|
|
||
| ## Adding images with captions | ||
|
|
||
| To add an image in Markdown file, we need to use the markdown syntax for this: {% raw %}``{% endraw %}. |
There was a problem hiding this comment.
We should maybe mention where to store the image
| ``` | ||
| {% endraw %} | ||
|
|
||
| ### Guidelines on Alt vs Figcaption Text |
There was a problem hiding this comment.
This section, the one before, and following ones look similar to the ones in "Tutorial" tutorial. Maybe we could put them in external Markdown and import them in both tutorials
There was a problem hiding this comment.
yeah it would be a good FAQ. I am often linking to it when reviewing tutorials
Co-authored-by: Bérénice Batut <bebatut@gmail.com>
xref #4611