Inleiding tot Azure DevOps-projectwiki's
Azure DevOps Projects bevat een optie voor het maken van een projectwiki.
De wiki voor het delen van informatie met uw team om inzicht te hebben in en bij te dragen aan uw project.
Wiki's worden opgeslagen in een opslagplaats. Er wordt geen wiki automatisch ingericht.
Vereisten
U moet gemachtigd zijn om een opslagplaats te maken om code als wiki te publiceren. Hoewel de groep Project Beheer istrators deze machtiging standaard heeft, kan deze aan anderen worden toegewezen.
Als u wikipagina's wilt toevoegen of bewerken, moet u lid zijn van de groep Inzenders .
Alle teamprojectleden (inclusief belanghebbenden) kunnen de wiki bekijken.
Maken
Het volgende artikel bevat informatie over het maken van een wiki: Een wiki maken voor uw project.
De wiki bewerken
Het volgende artikel bevat informatie over het publiceren van een Git-opslagplaats naar een wiki: Een Git-opslagplaats publiceren naar een wiki.
Markdown
Azure DevOps-wiki's zijn geschreven in Markdown en kunnen ook bestandsbijlagen en video's bevatten.
Markdown is een opmaaktaal. De tekst zonder opmaak bevat opmaaksyntaxis. Het is de feitelijke standaard geworden voor het schrijven van projecten en softwaredocumentatie.
Een van de belangrijkste redenen hiervoor is dat omdat deze bestaat uit tekst zonder opmaak, het eenvoudiger is om op dezelfde manier samen te voegen als de programmacode wordt samengevoegd.
Hiermee kunnen documenten worden beheerd met dezelfde hulpprogramma's die worden gebruikt om andere code in een project te maken.
GitHub Flavored Markdown (GFM)
GFM is een formele specificatie die door GitHub is uitgebracht en extensies heeft toegevoegd aan een basisindeling met de naam CommonMark. GFM wordt veel gebruikt zowel binnen GitHub als extern. GFM wordt weergegeven in Azure DevOps-wiki's.
Zeemeermin
Mermaid is een essentiële uitbreiding voor Markdown geworden, omdat hiermee diagrammen kunnen worden opgenomen in de documentatie.
Hiermee worden de problemen van het samenvoegen van documentatie opgelost, inclusief diagrammen die worden weergegeven als binaire bestanden.
Meer informatie over de syntaxis van Mermaid vindt u hier: Mermaid Introduction.