Bevezetés az Azure DevOps-projekt wikiibe

Befejeződött

Az Azure DevOps Projectsben lehetőség van projekt wiki létrehozására.

Screenshot of Azure DevOps wiki with title and description example.

A wiki, amely információkat oszt meg a csapatával, hogy megértse és hozzájáruljon a projekthez.

A wikik egy adattárban vannak tárolva. A rendszer nem épít ki automatikusan wikit.

Előfeltételek

Rendelkeznie kell engedéllyel ahhoz, hogy tárházat hozzon létre a kód wikiként való közzétételéhez. Bár a Project Rendszergazda istrators csoport alapértelmezés szerint rendelkezik ezzel az engedéllyel, másokhoz is hozzárendelhető.

Wikilapok hozzáadásához vagy szerkesztéséhez a Közreműködők csoport tagjának kell lennie.

A wikit a csapat összes tagja (beleértve az érdekelt feleket is) megtekintheti.

Creation

A következő cikk a wikik létrehozásával kapcsolatos részleteket tartalmazza: Wiki létrehozása a projekthez.

A wiki szerkesztése

Az alábbi cikk a Git-adattár wikiben való közzétételének részleteit tartalmazza: Git-adattár közzététele wikin.

Markdown

Az Azure DevOps Wikik a Markdownban vannak megírva, és fájlmellékleteket és videókat is tartalmazhatnak.

A Markdown egy korrektúranyelv. Az egyszerű szöveg formázási szintaxist tartalmaz. Ez lett a projektek és a szoftverdokumentációk írásának de facto szabványa.

Ennek egyik fő oka, hogy mivel egyszerű szövegből áll, könnyebben egyesíthető ugyanúgy, mint a programkód.

Lehetővé teszi a dokumentumok kezelését ugyanazokkal az eszközökkel, amellyel más kódokat hozhat létre egy projektben.

GitHub flavored Markdown (GFM)

A GFM a GitHub által kiadott hivatalos specifikáció, amely bővítményeket adott hozzá egy CommonMark nevű alapformátumhoz. A GFM-et széles körben használják mind a GitHubon, mind külsőleg. A GFM az Azure DevOps Wikikben jelenik meg.

Sellő

A Hableány a Markdown alapvető bővítményévé vált, mivel lehetővé teszi a diagramok dokumentációban való szerepeltetését.

Leküzdi a dokumentáció egyesítésének nehézségeit, beleértve a bináris fájlokként ábrázolt diagramokat is.

Screenshot of Mermaid Markup showing the welcome to the project wiki Contoso text and graph showing A and B dependencies.

Screenshot of Mermaid Rendering showing the welcome to the project wiki Contoso text and graph showing A and B dependencies.

A Hableány szintaxisával kapcsolatos részletek itt találhatók: Hableány – bevezetés.