ReviewNinja-Welcome

GitHub als documentatie

Doel is om te onderzoeken of GitHub mogelijk is als bron voor documentatie. ChatOps is de nieuwe naam in de markt. Alles wordt chat, kijk hier naar Hipchat of Slack

Maken van websites is mogelijk via bijvoorbeeld:

• GitHub Pages
• Jekyll

Wie is de doelgroep:

• Developers
• Iedereen die docu wil lezen

Voordelen:

• Binnen één repo heb je de code en documentatie
• Markdown is een krachtie taal (voorbeelden en rijke opmaak taal)
• Wokflow van github kan gebruikt worden. Er is één plek voor de geschiedenis en discussie
• Documentatie kan als code behandeld worden (automatiseren in CI straat)
• Doorzoekbaar maken is mogelijk, maar lijkt nog niet helemaal volwassen

Wie kan er bij de documentatie? Afschermen gaat op instance niveau. Wij maken gebruikt van privat mode. GitHub Enterprise Pages kunnen geconfigiureerd worden om publiek toegankelijk te maken.

Markdown

Opmaak in markdown kan eenvoudig via wat karacters gezet worden.

cursief [ ] checkbox

blockpquotes

/bin/bash

Met @stackbuilder kan een andere gituser of groep betrokken worden.

Review Ninja is de tool die af kan dwingen dat er een bepaald aantal sterren aanwezig moeten zijn.