In dit repository zit de handleinding van de Geonovum tooling. Deze handleiding heeft twee doelen:
- Handleiding van de tools binnen die binnen Geonovum gebruikt worden.
- De gezamenlijke werkwijze van Geonovum vast
De handleiding is in MarkDown geschreven en gebruikt mkdocs.
- Dit document is van iedereen. Als je geen schrijfrechten hebt vraag die dan aan bij een GitHub beheerder.
- De menustructuur zit in het bestandje
mkdocs.yml. Hierin is een aantal hoofdonderwerpen gedefinieerd. - Voor ieder hoofdonderwerp is een mapje gemaakt in de
docsfolder. - In iedere folder is een subfolder
mediavoor de plaatjes. - Als je je wijzingen commit en pusht naar github wordt de handleiding automatisch bijgewerkt
Mkdocs biedt ondersteuning om de gemaakte handleiding lokaal te previewen. Zie hiervoor de user guide. Twee opties zijn:
- Gebruik mkdocs buid om lokaal een statische versie van de handleiding te maken.
- Gebruik mkdocs serve om je eigen repository lokaal uit te serveren. Je zie dat de pages live mee veranderen.