Een wiki voor uw project maken

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

In dit artikel leert u hoe u een wiki opent en een Git-opslagplaats voor uw wiki maakt. Elk teamproject heeft een wiki. Gebruik de wiki om informatie te delen met uw team om inzicht te hebben in en bij te dragen aan uw project.

Elke teamprojectwiki wordt mogelijk gemaakt door een Git-opslagplaats in de back-end. Wanneer u een teamproject maakt, wordt er niet standaard een Git-wikiopslagplaats gemaakt. Maak een Git-opslagplaats om uw Markdown-wikibestanden op te slaan of publiceer bestaande Markdown-bestanden van een Git-opslagplaats naar een wiki.

Vereisten

• U moet een teamproject hebben. Als u nog geen teamproject hebt, maakt u er een in Azure DevOps.
• U moet ten minste basistoegang hebben om een wiki te maken en te wijzigen.
• U moet de machtiging Opslagplaats maken hebben om code als wiki te publiceren. Deze machtiging is standaard ingesteld voor leden van de groep Projectbeheerders.
• Iedereen die lid is van de beveiligingsgroep Inzenders veiigheidsgroep kan wikipagina's toevoegen of bewerken. Elke gebruiker met toegang tot het teamproject, inclusief belanghebbenden, kan de wiki bekijken.

De wiki openen

Browser

Verbinding maken naar uw project met behulp van een ondersteunde webbrowser en kies Wiki.

Als u van teamproject wilt wisselen, kiest u Azure DevOps om door alle teamprojecten en teams te bladeren.

Azure DevOps CLI

U kunt een wikipagina bekijken en openen die is gedefinieerd voor een project met behulp van de az devops wiki show opdracht. Zie Aan de slag met Azure DevOps CLI om aan de slag te gaan.

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

Parameters

• --wiki: vereist. Naam of id van de wiki.
• --open: optioneel. Open de wikipagina in uw webbrowser.
• --project -p: Optioneel. Naam of id van het project.
• --subscription: Optioneel. Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Opmerking

Open een wiki met de naam 'myprojectwiki'.

az devops wiki show --wiki myprojectwiki --open

Een wikipagina weergeven

Voer az devops wiki show de opdracht in om de inhoud van een pagina op te halen via de Azure DevOps CLI.

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

Parameters

• --path: vereist. Pad van de wikipagina.
• --wiki: vereist. Naam of id van de wiki.
• --include-content: Optioneel. Inhoud van de pagina opnemen.
• --open: optioneel. Open de wikipagina in uw webbrowser.
• --project -p: Optioneel. Naam of id van het project.
• --version -v: Optioneel. Versie (ETag) van de wikipagina.

Opmerking

Haal wikipagina-inhoud op met het pad 'mijn wiki' in een wiki met de naam 'myprojectwiki'.

az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"

Een Git-opslagplaats voor wiki's maken

Browser

Maak een nieuwe Git-opslagplaats waarin al uw wikipagina's en gerelateerde artefacten worden opgeslagen. Selecteer Project-wiki maken op de landingspagina van de wiki. Zelfs als u TFVC gebruikt voor broncodebeheer, kunt u een wiki maken met een Git-opslagplaats.

Als u geen toegang hebt om een Wiki Git-opslagplaats te maken of als u geen toegang hebt tot een van de bestaande wiki's, wordt het volgende bericht weergegeven.

Uw beheerder kan de Git-opslagplaats voor wiki's maken of u kunt aanvragen dat ze uw machtigingen verhogen. Belanghebbenden kunnen geen wiki maken, omdat ze geen machtigingen hebben om te werken in opslagplaatsen of code.

De Wiki Git-opslagplaats wordt aangeduid als TeamProjectName.wiki. Als uw teamproject bijvoorbeeld is, wordt foobar de wikiopslagplaats gelabeld foobar.wiki.

Notitie

Als u meer wiki's wilt maken, moet u code publiceren als wiki. U kunt meerdere wiki-opslagplaatsen instellen binnen één project.

Hoe kan ik naar de Git-opslagplaats gaan?

De TeamProjectName.wiki wordt niet weergegeven in de vervolgkeuzelijst met opslagplaatsen uit opslagplaatsen uit opslagplaatsen of code. Het bevindt zich ook niet in de lijst die is opgegeven op de pagina's van Project Instellingen > Opslagplaatsen of Project Instellingen > Versiebeheer.
U kunt er echter toegang toe krijgen via de volgende URL:

https://dev.azure.com/<Org_Name>/<Team_Project_Name>/_git/<Wiki_Name>

Selecteer Wiki klonen in het beletselteken bij de wikikiezer om toegang te krijgen tot de wiki-URL.

De URL van de Git-opslagplaats voor wiki's wordt weergegeven. Kopieer en plak deze in uw webbrowser om toegang te krijgen tot de onderliggende Git-opslagplaats.

Azure DevOps CLI

U kunt een wiki maken met de opdracht az devops wiki create . Zie Aan de slag met Azure DevOps CLI om aan de slag te gaan.

Notitie

Als u meer dan één wiki wilt maken, moet u code publiceren als wiki. U kunt meerdere wiki-opslagplaatsen instellen binnen één project.

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Parameters

• toegewezen pad: (vereist voor het codewiki-type ). Toegewezen pad van de nieuwe wiki. U kunt bijvoorbeeld opgeven / dat u wilt publiceren vanuit de hoofdmap van de opslagplaats.
• naam: (vereist voor het codewiki-type ). Naam van de nieuwe wiki. Als u geen naam opgeeft voor het type projectwiki, krijgt de nieuwe wiki de naam TeamProjectName.wiki.
• organisatie: URL van Azure DevOps-organisatie. U kunt de standaardorganisatie configureren met behulp van az devops configure -d organization=ORG_URL. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config. Voorbeeld: --org https://dev.azure.com/MyOrganizationName/.
• project: naam of id van het project. U kunt het standaardproject configureren met behulp van az devops configure -d project=NAME_OR_ID. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config.
• opslagplaats: (vereist voor het codewiki-type ). Naam of id van de opslagplaats waaruit de wiki moet worden gepubliceerd.
• type: Type wiki dat moet worden gemaakt. De geaccepteerde waarden zijn projectwiki (standaard) en codewiki.
• versie: (vereist voor het codewiki-type ). Naam van de opslagplaatsbranch om de codewiki te publiceren.

Opmerking

Met de volgende opdracht maakt u een wiki met de naam Fabrikam Fiber en ziet u de uitvoer in tabelindeling.

az devops wiki create --name "Fabrikam Fiber" --output table

ID                                    Name                 Type
------------------------------------  -------------------  -----------
7edcc35b-89be-465e-855e-377ba8660af7  Fabrikam Fiber.wiki  projectWiki

Volgende stappen

Wikipagina's toevoegen en bewerken