Crea un wiki per il progetto

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

Questo articolo illustra come aprire un wiki e creare un repository Git per il wiki. Ogni progetto team ha un wiki. Usare il wiki per condividere informazioni con il team per comprendere e contribuire al progetto.

Ogni wiki del progetto team è basato su un repository Git nel back-end. Quando si crea un progetto team, un repository Git wiki non viene creato per impostazione predefinita. Creare un repository Git per archiviare i file Markdown wiki o pubblicare file Markdown esistenti da un repository Git in un wiki.

Prerequisiti

• È necessario avere un progetto team. Se non si ha ancora un progetto team, crearne uno in Azure DevOps.
• Per creare e modificare un wiki, è necessario disporre almeno dell'accesso Di base.
• È necessario disporre dell'autorizzazione Create Repository (Crea repository ) per pubblicare il codice come wiki. Per impostazione predefinita, questa autorizzazione è impostata per i membri del gruppo di amministratori di progetto.
• Chiunque sia membro del gruppo di sicurezza Collaboratori può aggiungere o modificare pagine del wiki. Qualsiasi utente con accesso al progetto team, inclusi gli stakeholder, può visualizzare il wiki.

Aprire il wiki

Browser

Connessione al progetto usando un Web browser supportato e scegliere Wiki.

Se è necessario cambiare il progetto team, scegliere Azure DevOps per esplorare tutti i progetti e i team del team.

Interfaccia della riga di comando di Azure DevOps

È possibile visualizzare e aprire una pagina wiki definita per un progetto usando il az devops wiki show comando . Per iniziare, vedere Introduzione all'interfaccia della riga di comando di Azure DevOps.

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

Parametri

• --wiki: obbligatorio. Nome o ID del wiki.
• --open: facoltativo. Aprire la pagina wiki nel Web browser.
• --project -p: Facoltativo. Nome o ID del progetto.
• --subscription: facoltativo. Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Esempio

Aprire un wiki denominato "myprojectwiki".

az devops wiki show --wiki myprojectwiki --open

Visualizzare una pagina wiki

Per ottenere il contenuto di una pagina tramite l'interfaccia della riga di comando di Azure DevOps, immettere il az devops wiki show comando .

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

Parametri

• --path: obbligatorio. Percorso della pagina wiki.
• --wiki: obbligatorio. Nome o ID del wiki.
• --include-content: facoltativo. Includere il contenuto della pagina.
• --open: facoltativo. Aprire la pagina wiki nel Web browser.
• --project -p: Facoltativo. Nome o ID del progetto.
• --version -v: facoltativo. Versione (ETag) della pagina wiki.

Esempio

Ottenere il contenuto della pagina wiki con il percorso "il mio wiki" in un wiki denominato "myprojectwiki".

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

Creare un repository Git wiki

Browser

Creare un nuovo repository Git che archivia tutte le pagine wiki e gli artefatti correlati. Nella pagina di destinazione wiki selezionare Crea wiki del progetto. Anche se si usa TFVC per il controllo del codice sorgente, è possibile creare un wiki con un repository Git.

Se non si ha accesso per creare un repository Git wiki o se non si ha accesso a nessun wiki esistente, viene visualizzato il messaggio seguente.

L'amministratore può creare il repository Git wiki oppure richiedere l'elevazione delle autorizzazioni. Gli stakeholder non possono creare un wiki, perché non dispongono delle autorizzazioni necessarie per lavorare in Repos o Codice.

Il repository Git wiki è definito TeamProjectName.wiki. Ad esempio, se il progetto team è foobar , il repository wiki viene etichettato foobar.wiki.

Nota

Se si vogliono creare altri wiki, è necessario pubblicare il codice come wiki. È possibile configurare più repository wiki all'interno di un singolo progetto.

Come è possibile passare al repository Git?

TeamProjectName.wiki non viene visualizzato nel menu a discesa dei repository da Repos o Codice. Non è presente anche nell'elenco fornito dalle pagine Project Impostazioni > Repository o Project Impostazioni > Controllo della versione.
Tuttavia, è possibile ottenerlo dall'URL seguente:

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

Selezionare Clone Wiki (Clona wiki) dai puntini di sospensione accanto alla selezione wiki per accedere all'URL wiki.

L'URL del repository Git wiki è esposto. Copiare e incollarlo nel Web browser per accedere al repository Git sottostante.

Interfaccia della riga di comando di Azure DevOps

È possibile creare un wiki con il comando az devops wiki create . Per iniziare, vedere Introduzione all'interfaccia della riga di comando di Azure DevOps.

Nota

Per creare più wiki, è necessario pubblicare codice come wiki. È possibile configurare più repository wiki all'interno di un singolo progetto.

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

Parametri

• mappingd-path: (obbligatorio per il tipo codewiki ). Percorso mappato del nuovo wiki. Ad esempio, è possibile specificare / di pubblicare dalla radice del repository.
• name: (obbligatorio per il tipo codewiki ). Nome del nuovo wiki. Se non si specifica un nome per il tipo projectwiki, il nuovo wiki viene denominato TeamProjectName.wiki.
• org: URL dell'organizzazione di Azure DevOps. È possibile configurare l'organizzazione predefinita usando az devops configure -d organization=ORG_URL. Obbligatorio se non è configurato come predefinito o prelevato tramite git config. Esempio: --org https://dev.azure.com/MyOrganizationName/.
• project: nome o ID del progetto. È possibile configurare il progetto predefinito usando az devops configure -d project=NAME_OR_ID. Obbligatorio se non è configurato come predefinito o prelevato tramite git config.
• repository: (obbligatorio per il tipo codewiki ). Nome o ID del repository da cui pubblicare il wiki.
• type: tipo di wiki da creare. I valori accettati sono projectwiki (impostazione predefinita) e codewiki.
• version: (obbligatorio per il tipo codewiki ). Nome del ramo del repository da cui pubblicare il wiki del codice.

Esempio

Il comando seguente crea un wiki denominato "Fabrikam Fiber" e mostra l'output in formato tabella.

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

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

Passaggi successivi

Aggiungere e modificare pagine wiki