Skip to content

Commit

Permalink
fixed urls, after spec for folders was implemented in learning-portal
Browse files Browse the repository at this point in the history
  • Loading branch information
johannesloetzsch committed Dec 11, 2024
1 parent f3df6f8 commit eeb8e8e
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 23 deletions.
9 changes: 0 additions & 9 deletions 10_Quickstart/quickstart.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Vocabulary

@see [Glossar](../80_Glossar/glossar.md)
@see [Glossar](../Glossar/glossar.md)

We reintroduce some terms from the glossar here, to make them more visible and help non german speakers to understand the structure.

Expand Down
File renamed without changes.
19 changes: 19 additions & 0 deletions Quickstart/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Quickstart

Dieser Quickstart zeigt, wie neue Kurse für den Schulstick erstellt werden.



## Markdown

`TODO` knapp erklären, dass „nur“ Markdown benötigt wird

## Liascript

`TODO` Liascript und die Nutzung des Editors

## Tutorials im Portal (auf dem Lernstick) einbinden

.local/share/learning-portal/courses/draft/mein_quckickstart_tutorial/erste_lektion

mkdir -p ~/.local/share/learning-portal/courses/draft/mein_quckickstart_tutorial/erste_lektion
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ In diesem Repo entsteht die Dokumentation für das [Schulstick Portal](https://g

### Inhalte

* Zunächst wird ein [Quickstart-Tutorial](10_Quickstart/quickstart.md) erstellt
* Zunächst wird ein [Quickstart-Tutorial](Quickstart/quickstart.md) erstellt
* Es wird bis zum Workshop benötigt ([Issue](https://github.com/fsfw-dresden/schulstick-tutorial-docs/issues/1))
* Wir wollen den Quickstart so kurz wie möglich halten, aber so hilfreich wie möglich gestalten. Um das ermöglichen zu können, haben wir folgende Überlegungen:
* Das Portal soll [Convention over configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) umsetzen. Wir wollen minimalen Aufwand von den Tutorialserstellern (nur eine Markdown-Datei) und haben selber die geeigneten Defaults statt der Notwendigkeit zu zusätzlichen Konfigurationen.
Expand Down Expand Up @@ -32,6 +32,6 @@ flowchart TD
Claim --> Quickstart([Quickstart])
```

* Um den Quickstart als Grundlage für die Umsetzung entsprechend umsetzen zu können, Enthällt dieses Repo auch eine Formulierung unserer [Ziele](./01_Ziel/ziel.md) und [Versprechen](./02_Claim/claim.md)
* Um den Quickstart als Grundlage für die Umsetzung entsprechend umsetzen zu können, Enthällt dieses Repo auch eine Formulierung unserer [Ziele](./Ziel/ziel.md) und [Versprechen](./Claim/claim.md)

* Um einheitliche Begriffe (und vielleicht einprägsamme „Markennamen“) zu haben, wird ein [Glossar](80_Glossar/glossar.md) erstellt.
* Um einheitliche Begriffe (und vielleicht einprägsamme „Markennamen“) zu haben, wird ein [Glossar](Glossar/glossar.md) erstellt.
12 changes: 6 additions & 6 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Summary

* [Über dieses Repo](README.md)
* [Ziele](./01_Ziel/ziel.md)
* [Claim](./02_Claim/claim.md)
* [Quickstart](10_Quickstart/quickstart.md)
* [Ordnerstruktur](20_Folders_Sources/folders.md)
* [Glossar](80_Glossar/glossar.md)
* [WIP spec](99_wip_spec/intro.md)
* [Ziele](Ziel/ziel.md)
* [Claim](Claim/claim.md)
* [Quickstart](Quickstart/quickstart.md)
* [Ordnerstruktur](Folders_Sources/folders.md)
* [Glossar](Glossar/glossar.md)
* [WIP spec](wip_spec/intro.md)
File renamed without changes.
8 changes: 4 additions & 4 deletions 99_wip_spec/intro.md → wip_spec/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Die folgende Anleitung erklärt alle nötigen Schritte um:

## Aufbau von Tutorials

Wir sammeln und pflegen Tutorials in einem gemeinsamen [Verzeichnis auf Github](https://github.com/fsfw-dresden/schulstick-portal/tree/main/tutor-next/markdown).
Wir sammeln und pflegen Tutorials in einem gemeinsamen [Verzeichnis auf Github](https://github.com/fsfw-dresden/learning-portal/tree/main/OER-materials/examples).
<!-- TODO künftiges Repo/Metaverzeichnis -->

Keine Angst, für keinen der Schritte aus dieser Anleitung ist Wissen über Git notwendig. Um eine einfache Anleitung zu erstellen, müssen nur drei Dateien erstellt und uns zugesendet werden.

Hier ein [einfaches Beispiel](https://github.com/fsfw-dresden/schulstick-portal/tree/main/tutor-next/markdown/schulstick_tutorial/lektion1) eines Tutorials:
Hier ein [einfaches Beispiel](https://github.com/fsfw-dresden/learning-portal/tree/main/OER-materials/examples/schulstick_tutorial/lektion1) eines Tutorials:
<!-- TODO Template statt Selbstreferenz -->

Der Ordner enthällt die nötigen 3 Dateien:
Expand All @@ -54,7 +54,7 @@ Diese Datei beinhaltet die eigentlichen Inhalte.

Die Datei ist in der Auszeichnungssprache [**Markdown**](https://de.wikipedia.org/wiki/Markdown) geschrieben.

Wie [unser Beispiel](https://raw.githubusercontent.com/fsfw-dresden/schulstick-portal/refs/heads/main/tutor-next/markdown/schulstick_tutorial/lektion1/intro.md) zeigt, die Datei ein einem leicht lesbaren Textformat (Ausgangsform). Da sie eine maschinenlesbare Struktur hat, kann sie automatisch in eine [schöne Zielform](https://github.com/fsfw-dresden/schulstick-portal/tree/main/tutor-next/markdown/schulstick_tutorial/lektion1/intro.md) übersetzt werden.
Wie [unser Beispiel](https://raw.githubusercontent.com/fsfw-dresden/learning-portal/refs/heads/main/OER-materials/examples/schulstick_tutorial/lektion1/intro.md) zeigt, die Datei ein einem leicht lesbaren Textformat (Ausgangsform). Da sie eine maschinenlesbare Struktur hat, kann sie automatisch in eine [schöne Zielform](https://github.com/fsfw-dresden/learning-portal/blob/main/OER-materials/examples/schulstick_tutorial/lektion1/intro.md) übersetzt werden.

Markdown zu lernen ist einfach und geht schnell. Die wenigen nötigen Auszeichnugen werden [hier beschrieben](https://de.wikipedia.org/wiki/Markdown#Auszeichnungsbeispiele).

Expand All @@ -73,7 +73,7 @@ Es gibt einen [Online-Editor](https://liascript.github.io/LiveEditor/?/show/file

Die in Markdown/LiaScript geschriebene Datei (`intro.md`) ist ausreichend um eine Anleitung unabhängig vom Schulscript zu schreiben.

[`metadata.yml`](https://raw.githubusercontent.com/fsfw-dresden/schulstick-portal/refs/heads/main/tutor-next/markdown/schulstick_tutorial/lektion1/metadata.yml) enthällt alle [Metadaten](https://de.wikipedia.org/wiki/Metadaten), welche vom Schulstick-Portal benötigt werden, um zusätzliche Funktionen zu ermöglichen.
[`lessen.yml`](https://github.com/fsfw-dresden/learning-portal/blob/main/OER-materials/examples/schulstick_tutorial/lektion1/lesson.yml) enthällt alle [Metadaten](https://de.wikipedia.org/wiki/Metadaten), welche vom Schulstick-Portal benötigt werden, um zusätzliche Funktionen zu ermöglichen. Sie wird künftig optional sein.

Wir werden in einem späteren Abschnitt beschreiben, wie die Datei einfach erstellt/angepasst/getestet werden kann und welche Werte in ihr erlaubt sind.
<!-- TODO
Expand Down
File renamed without changes.
File renamed without changes

0 comments on commit eeb8e8e

Please sign in to comment.