Documentatie schrijven

De documentatie wordt bijgehouden op GitHub. Aaah, code! Nee, komt goed. Dit is hoe je onze documentatie bijwerkt.

Bestaande pagina aanpassen

Ga naar de pagina die je wilt bewerken en druk op Bewerk deze pagina in het rechter menu. Je komt nu op de juiste pagina in GitHub uit. Druk op het potloodje om de pagina te bewerken.

Doe je aanpassingen. De documentatie is in Markdown geschreven. Als je nog niet bekend bent met Markdown, kun je hier (opens in a new tab) meer lezen over hoe je het kunt gebruiken.

Als je klaar bent met je aanpassingen, scroll je naar beneden en vul je een titel in bij Commit changes. Daaronder kun je een beschrijving van je aanpassingen toevoegen. Als je klaar bent, druk je op Propose changes.

Je komt nu op een pagina om een Pull Request te maken. Een Pull Request is een verzoek om je aanpassingen in de documentatie te accepteren. Als je klaar bent, druk je op Create pull request.

Een andere Labfreak moet nu je aanpassingen goedkeuren. Zo zorgen we dat er altijd iemand meekijkt voordat de aanpassingen live gaan.

Volgorde menu aanpassen

Het menu wordt automatisch gegenereerd. Je kunt de volgorde van het menu aanpassen door het bestand _meta.json in de map waar je in bezig bent, te openen. Daar staat een lijst met alle pagina's in die map. De volgorde van de pagina's in die lijst bepaalt de volgorde in het menu.

Let op het gebruik van komma's. JSON is daar daar heel gevoelig voor. Als je het niet goed hebt staan, zie je een foutmelding.