Move usage instructions from readme to docs.fitko.de/meta/
Currently, the Readme file contains instructions on how to update docusaurus contents. These information are getting out of sync when individual copies of the docusaurus-template
repo are created. Therefore, we want to move documentation from the Readme to docs.fitko.de/meta.
Our goal: Advanced beginners should be able to start without reading docs.fitko.de/meta, first-time users without knowledge about docusaurs should start at docs.fitko.de/meta where they are guided through the process of editing docusaurus projects.
-
Template für eine Docusaurus-Seite
-
Ersetzen von Projekt-Variablen
-> leave in project readme (this typically gets removed during project initiation, see efa-parametrisierung@5033b3ee for example) -
Lokale Entwicklung
-> this is super helpful. Leave in readme! -
Dokumentation des Inhalts
-> only leave link to https://docs.fitko.de/meta/usage, first paragraph about markdown. Add info aboutdocs/
folder where md files are stored. Move info aboutApiSpec
component to meta.-
Versionierte Dokumentation (optional)
-> move to meta -
Die Navigationselemente
-> copy to meta (this is helpful for advanced beginners) -
Die Seitennavigation
-> copy to meta (this is helpful for advanced beginners) -
Das Glossar (optional)
-> move to meta, including all sub-headingsBegriff erstellen
Verwendung von Mustern zur Referenzierung
Beispiel
Lokales testen der Änderungen
Mögliche Probleme bei der Einbindung
Erzeugung der Glossar-Docs in der CI
-
-
Deployment via CI/CD
-> only leave link to docs.fitko.de/meta in readme and move contents to meta -
License
-> leave in project readme!
-