search

carpentries / curriculum-development

The Curriculum Development Handbook. How to assemble and maintain a Carpentries lesson.
https://cdh.carpentries.org
Other
23 stars 18 forks source link

Document how to specify the path to an image file in a lesson #71

Open tobyhodges opened 3 years ago

tobyhodges commented 3 years ago

After https://github.com/carpentries/lesson-example/issues/230 has been closed, add some brief instructions for writing internal links/specifying path to image file. Link to the documentation in the Lesson Example for more details.

This should be added to the Technological Introductions chapter, and linked to from the appendix on converting existing lessons in other formats.

bencomp commented 1 year ago

I just suggested to remove (most of) the Technological Introductions in #78. I would agree with including a guideline that says, e.g., to include an image in the repository if allowed instead of linking to online images, and to provide proper attribution around the image, but leave the technicalities of how to specify the path to the image to the documentation of the lesson infrastructure.

What do you think?