Skapa en wiki för ditt projekt

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

I den här artikeln lär du dig hur du öppnar en wiki och skapar en Git-lagringsplats för din wiki. Varje teamprojekt har en wiki. Använd wikin för att dela information med ditt team för att förstå och bidra till ditt projekt.

Varje teamprojekt-wiki drivs av en Git-lagringsplats i serverdelen. När du skapar ett teamprojekt skapas inte en Wiki Git-lagringsplats som standard. Skapa en Git-lagringsplats för att lagra dina Wiki Markdown-filer eller publicera befintliga Markdown-filer från en Git-lagringsplats till en wiki.

Förutsättningar

• Du måste ha ett teamprojekt. Om du inte har något teamprojekt än skapar du ett i Azure DevOps.
• Du måste ha minst grundläggande åtkomst för att skapa och ändra en wiki.
• Du måste ha behörigheten Skapa lagringsplats för att publicera kod som wiki. Som standard anges den här behörigheten för medlemmar i gruppen Projektadministratörer.
• Alla som är medlemmar i säkerhetsgruppen Deltagare kan lägga till och redigera wiki-sidor. Alla användare med åtkomst till teamprojektet, inklusive intressenter, kan visa wikin.

Öppna Wikin

Webbläsare

Anslut till projektet med hjälp av en webbläsare som stöds och välj Wiki.

Om du behöver byta teamprojekt väljer du Azure DevOps för att bläddra bland alla teamprojekt och team.

Azure DevOps CLI

Du kan visa och öppna en wiki-sida som definierats för ett projekt med hjälp av az devops wiki show kommandot . Kom igång genom att läsa Komma igång med Azure DevOps CLI.

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

Parametrar

• --wiki: Krävs. Namn eller ID för wikin.
• --open: Valfritt. Öppna wiki-sidan i webbläsaren.
• --project -p: Valfritt. Projektets namn eller ID.
• --subscription: Valfritt. Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Exempel

Öppna en wiki med namnet "myprojectwiki".

az devops wiki show --wiki myprojectwiki --open

Visa en wiki-sida

Om du vill hämta innehållet på en sida via Azure DevOps CLI anger du az devops wiki show kommandot .

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

Parametrar

• --path: Krävs. Sökväg till wiki-sidan.
• --wiki: Krävs. Namn eller ID för wikin.
• --include-content: Valfritt. Ta med innehållet på sidan.
• --open: Valfritt. Öppna wiki-sidan i webbläsaren.
• --project -p: Valfritt. Projektets namn eller ID.
• --version -v: Valfritt. Wiki-sidans version (ETag).

Exempel

Hämta wiki-sidinnehåll med sökvägen "min wiki" i en wiki med namnet "myprojectwiki".

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

Skapa en Wiki Git-lagringsplats

Webbläsare

Skapa en ny Git-lagringsplats som lagrar alla dina wiki-sidor och relaterade artefakter. På wiki-landningssidan väljer du Skapa projekt-wiki. Även om du använder TFVC för källkontroll kan du skapa en wiki med en Git-lagringsplats.

Om du inte har åtkomst till att skapa en Wiki Git-lagringsplats eller om du inte har åtkomst till någon av de befintliga wiki-datorerna visas följande meddelande.

Administratören kan skapa Wiki Git-lagringsplatsen eller begära att de höjer dina behörigheter. Intressenter kan inte skapa en wiki eftersom de inte har behörighet att arbeta i Repos eller Code.

Wiki Git-lagringsplatsen kallas TeamProjectName.wiki. Om ditt teamprojekt till exempel är foobar så är wiki-lagringsplatsen foobar.wikimärkt .

Kommentar

Om du vill skapa fler wikis måste du publicera kod som en wiki. Du kan konfigurera flera wiki-lagringsplatser i ett enda projekt.

Hur går jag till Git-lagringsplatsen?

TeamProjectName.wiki visas inte i den nedrullningsbara menyn med lagringsplatser från lagringsplatser eller kod. Den finns inte heller i listan från sidorna Project Inställningar > Repositories eller Project Inställningar > Version Control.
Du kan dock komma åt det från följande URL:

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

Välj Klona Wiki från ellipsen nära wiki-väljaren för att få åtkomst till wiki-URL:en.

URL:en för Wiki Git-lagringsplatsen exponeras. Kopiera och klistra in den i webbläsaren för att få åtkomst till den underliggande Git-lagringsplatsen.

Azure DevOps CLI

Du kan skapa en wiki med kommandot az devops wiki create . Kom igång genom att läsa Komma igång med Azure DevOps CLI.

Kommentar

Om du vill skapa fler än en wiki måste du publicera kod som en wiki. Du kan konfigurera flera wiki-lagringsplatser i ett enda projekt.

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

Parametrar

• mapped-path: (Krävs för codewiki-typen ). Mappad sökväg för den nya wikin. Du kan till exempel ange / att publicera från lagringsplatsens rot.
• name: (Krävs för codewiki-typen ). Namnet på den nya wikin. Om du inte anger ett namn för typen projectwiki får den nya wikin namnet TeamProjectName.wiki.
• org: Url för Azure DevOps-organisationen. Du kan konfigurera standardorganisationen med .az devops configure -d organization=ORG_URL Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config. Exempel: --org https://dev.azure.com/MyOrganizationName/.
• project: Projektets namn eller ID. Du kan konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config.
• lagringsplats: (Krävs för codewiki-typen ). Namn eller ID för lagringsplatsen som wikin ska publiceras från.
• typ: Typ av wiki som ska skapas. De godkända värdena är projectwiki (standard) och codewiki.
• version: (Krävs för codewiki-typen ). Namnet på lagringsplatsens gren för att publicera kod-wikin från.

Exempel

Följande kommando skapar en wiki med namnet "Fabrikam Fiber" och visar utdata i tabellformat.

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

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

Nästa steg

Lägga till och redigera wiki-sidor