Lerninhalte, Katalog und Plattform

Zusammenhang Lerninhalte, Katalog und Plattform

• Lerninhalte werden in Themen, Technologien und Lektionen untergliedert.
• Die Generierung der jeweiligen Routes in der Webanwendung erfolgt dynamisch anhand der zur Verfügung gestellten Markdown Dateien unter Katalog/... .
• Die Pfade zu den Projekten der jeweiligen Lektionen werden ebenfalls automatisch aus der unter Lektionen/... hinterlegten Ordnerstruktur abgeleitet.

Beschreibung der Lerninhalte

Katalog/
.. Thema/
.. thema.md
.. .. Technologie/
.. .. technologie.md
.. .. .. Lektion/
.. .. .. .. lektion.md


Katalog/                                                      
.. Frontend-Web-Entwicklung/                                  Thema                               
.. frontend-Web-Entwicklung.md                               
.. .. React/                                                  Technologie                                     
.. .. react.md                                               
.. .. .. Props/                                               Lektion
.. .. .. .. props.md                                         

zugehörige URI

https://learn2code-hska.web.app/Thema/Technologie/Lektion

https://learn2code-hska.web.app/Front-End-Webentwicklung/React/Props

zugehörige Lektion

Lektionen/
.. Thema/
.. .. Technologie/
.. .. .. Lektion/
.. .. .. .. Projekt Dateien
.. .. .. .. lecture.zip

Lektionen/
.. Frontend-Web-Entwicklung/                                  Thema
.. .. React/                                                  Technologie
.. .. .. Props/                                               Lektion
.. .. .. .. src/
.. .. .. .. lecture.zip
.. .. .. .. package.json
.
.
.

Beschreibung neuer Lerninhalte hinzufügen

Speicherort: Katalog/...

Typ: Markdown Datei

• Beschreibungen sind in Markdown anzufertigen. Templates für die Dateien der jeweiligen Ebene (Thema, Technologie, Lektion) befinden sich im Katalog.
• Dateinamen sind kleinzuschreiben, Ordnernamen groß.

Thema

• Beschreibungen neuer Themen sind auf Root-Ebene abzulegen. Analog zu jedem Thema sollte es einen Ordner geben, welcher die Beschreibungen zugehöriger Technologien und Lektionen enthält.
• Der pathTitle der Frontmatter-Section eines Themas muss identisch mit dem zugehörigen Ordnernamen sein.
• Es wird empfohlen zu jeder Technologie ein Icon im PNG-/JPEG-Format zu hinterlegen, um die UI ansprechender zu gestalten.

Technologie

• Beschreibungen neuer Technologien sind im Ordner des jeweiligen Themas abzulegen. Analog zu jeder Technologie sollte es einen Ordner geben, welcher die Beschreibung zugehöriger Lektionen enthält.
• Wie auch bei Themen müssen pathTitle und Ordnername identisch sein.
• Für Technologien wird ebenfalls empfohlen ein PNG-/JPEG-Icon zu hinterlegen.

Lektionen

• Beschreibungen neuer Lektionen sind in einem Ordner welcher sich unterhalb der zugehörigen Technologie befindet abzulegen.
• Der pathTitle und Ordnername müssen auch hier identisch sein, mit dem Unterschied, dass sich die Beschreibung der Lektion im zugehörigen Ordner befindet.
• Die Anleitung für die jeweiligen Lektionen wird in das Lektionsdokument geschrieben. Dabei kann ganz normal Markdown geschrieben und alle zugehörigen Funktionen verwendet werden.

Genauere Anleitungen zur Erstellung der Dokumente sind den oben verlinkten Templates zu entnehmen.

Code für neue Lektionen hinterlegen

Speicherort: Lektionen/...

Typ: Projektordner

• Projekte neuer Lektionen sind unter Lektionen/{{Thema}}/{{Technologie}}/{{Lektion}} abzulegen.
• Im Root-Verzeichnis des Projektes sollte sich eine lecture.zip-Datei befinden, welche das gesamte Projekt enthält. Studierenden soll die Möglichkeit geboten werden, die Lektionen zu downloaden und auf dem eigenen Rechner auszuführen.
• Lektionen, welche in der eingebetteten Stackblitz Instanz ausgeführt werden können, müssen über die Property onlineIDE in der Frontmatter Sektion extra gekennzeichnet werden. Für alle anderen Lektionen muss eine Anleitung wie diese auf dem eigenen Rechner zu bearbeiten ist vorhanden sein.