Network Reliability Engineering Community

Local Images for Lesson Diagrams

When creating new lessons, in the syringe.yml file, there is a ‘lessonDiagram’ value and all of the examples show a URL to an image. Is there any way to include lesson diagram images in the lesson-xx directory and have them displayed in the lesson?

Right now the only way to do this is to provide the raw Github URL to that image. So, when you’re including a lesson diagram, be sure to commit it into your lesson directory, and then reference it using the raw URL in your lesson definition like so:

lessonDiagram: https://raw.githubusercontent.com/nre-learning/nrelabs-curriculum/master/lessons/lesson-15/lessondiagram.png

In the near future, we’re hoping to be able to serve images directly from the Syringe API so that you don’t have to specify this at all, so stay tuned for that. However, this is how it needs to be done today.