Skip to content
Snippets Groups Projects
Commit 331d7713 authored by Lukas Ruge's avatar Lukas Ruge
Browse files

doku

parent 138e5a62
No related branches found
No related tags found
No related merge requests found
Pipeline #23466 passed
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
### Für wen ist diese Doku (nicht) ### Für wen ist diese Doku (nicht)
Dies ist keine Doku für Menschen, die einfach auf unserer Website surfen wollen und sie benutzen wollen. Die Hoffnung ist, das geht einfach so. ganz ohne Doku. Es ist auch keine Doku für Menschen, die an dieser Website programmieren. Hierzu wird es langfristig (hoffentlich) eine Entwicklungsdoku geben, welche es erleichtert neue Features einzubauen. Dies ist keine Doku für Menschen, die einfach auf unserer Website surfen wollen und sie benutzen wollen. Die Hoffnung ist, das geht einfach so. ganz ohne Doku. Es ist kaum eine Doku für Menschen, die an dieser Website programmieren (unten gibt es etwas rudimentäre dev-docs). Hierzu wird es langfristig (hoffentlich) mehr Entwicklungsdoku geben, welche es erleichtert neue Features einzubauen. Aber die Zielgruppe ist hier doch sehr klein und miteinander reden vermutlich meist effizienter.
Diese Doku ist für Menschen, die Content erstellen wollen. Sie soll ein Verständnis schaffen, wie Inhalte strukturiert sind, wie sie abgelegt werden, auf was dabei zu achten ist und welche Verknüpfungen geschehen. Das ist nämlich dank der Komplexität der Website nicht (immer) einfach. *Diese Doku ist für Menschen, die Content erstellen wollen. Sie soll ein Verständnis schaffen, wie Inhalte strukturiert sind, wie sie abgelegt werden, auf was dabei zu achten ist und welche Verknüpfungen geschehen. Das ist nämlich dank der Komplexität der Website nicht (immer) einfach.*
Die Doku soll auch einen Überblick darüber geben, wo die Website von anderen Systemen als Informationsquelle genutzt wird oder Informationen anderer Quellen nutzt, um sich beim Erstellen von Content dieser Abhängigkeiten bewusst zu sein und zu wissen: Änderungen können effekte außerhalb der Website haben. *Die Doku soll auch einen Überblick darüber geben, wo die Website von anderen Systemen als Informationsquelle genutzt wird oder Informationen anderer Quellen nutzt, um sich beim Erstellen von Content dieser Abhängigkeiten bewusst zu sein und zu wissen: Änderungen können effekte außerhalb der Website haben.*
Die Doku versucht auch, im Ansatz, Fragen zu beantworten wie: Was soll auf die Website? Was soll ins Wiki? Was ist vielleicht besser eine subdomain oder ganz andere Seite? *Die Doku versucht auch, im Ansatz, Fragen zu beantworten wie: Was soll auf die Website? Was soll ins Wiki? Was ist vielleicht besser eine subdomain oder ganz andere Seite?*
Beschrieben, oder verlinkt, werden daher auch einige Systeme, die Eng mit der Website kooperieren oder für ihren Betrieb relevant sind. Beschrieben, oder verlinkt, werden daher auch einige Systeme, die eng mit der Website kooperieren oder für ihren Betrieb relevant sind.
Aufgeteilt ist die Dokumentation folgendermaßen: Aufgeteilt ist die Dokumentation folgendermaßen:
...@@ -51,7 +51,7 @@ Aufgeteilt ist die Dokumentation folgendermaßen: ...@@ -51,7 +51,7 @@ Aufgeteilt ist die Dokumentation folgendermaßen:
* [im Ordner docs](/docs/dev/README.md). * [im Ordner docs](/docs/dev/README.md).
* [Website Lokal starten](/docs/dev/local.md) * [Website Lokal starten](/docs/dev/local.md)
* [Print-CSS](/docs/dev/print-css.md) * [Print-CSS](/docs/dev/print-css.md)
* [Layouts anpassen](/docs/content/layouts.md) * [Layouts anpassen](/docs/dev/layouts.md)
* **Builds Scripts** * **Builds Scripts**
* [Check auf Dead-Links](/docs/build/deadlinks.md) * [Check auf Dead-Links](/docs/build/deadlinks.md)
* [iCal Prüfung](/docs/build/icalcheck.md) * [iCal Prüfung](/docs/build/icalcheck.md)
......
...@@ -28,6 +28,8 @@ Eine andere Bewertung kann Änderungshäufigkeit sein. Ein einmal erstellter Inh ...@@ -28,6 +28,8 @@ Eine andere Bewertung kann Änderungshäufigkeit sein. Ein einmal erstellter Inh
Auch ein Kriterium kann sein, dass die Website gut mit Sammlungen von Inhalten umgehen kann, da *jekyll* das gut verstehe und diese leicht als markdown mit Hilfe von Programmen erstellt und verwaltet werden können. Auch ein Kriterium kann sein, dass die Website gut mit Sammlungen von Inhalten umgehen kann, da *jekyll* das gut verstehe und diese leicht als markdown mit Hilfe von Programmen erstellt und verwaltet werden können.
Zudem bietet das Wiki die Option für bestimmte Bereiche ein Login zu fordern. So können dort Daten abgelegt werden, die zwar nicht geheim sind (jeder mit einem LDAP Account kann sie sehen) aber die auch nicht öffentlich sind. Die Website ist öffentlich.
**Basically: Inhalte auf der Website sind Repräsentativ und/oder statisch, Wiki ist Doku und soll sich den Gegebenheiten kontinuierlich anpassen.** **Basically: Inhalte auf der Website sind Repräsentativ und/oder statisch, Wiki ist Doku und soll sich den Gegebenheiten kontinuierlich anpassen.**
Im Detail stimmt das ab und zu nicht. Für Dienste (BBB, git,…) ist das Wiki z.B. auch für die statische, repräsentative Sache zuständig. In anderen Punkten, z.B. im Kontext Verleih ist die Website recht nah an einer Doku. Das ist also flexibel, aber darüber sollte man immer nachdenken Im Detail stimmt das ab und zu nicht. Für Dienste (BBB, git,…) ist das Wiki z.B. auch für die statische, repräsentative Sache zuständig. In anderen Punkten, z.B. im Kontext Verleih ist die Website recht nah an einer Doku. Das ist also flexibel, aber darüber sollte man immer nachdenken.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment