Clonare e aggiornare il contenuto wiki offline

  • Articolo

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

È possibile aggiornare le pagine del wiki offline nello stesso modo in cui si sviluppa il codice in un repository Git.

È possibile usare qualsiasi client che si vuole o git command-line tools per aggiornare il wiki offline. Per informazioni dettagliate sull'uso dei repository Git e degli strumenti supportati, vedere Repository Git.

I passaggi di base per aggiornare il contenuto dei wiki offline sono i seguenti:

  1. Clonare il repository Git wiki nell'IDE o nell'area di lavoro locale.
  2. Aggiungere file o cartelle al ramo Git locale.
  3. Aggiornare i file con estensione order per riflettere le pagine e le pagine secondarie.
  4. Eseguire il commit e il push degli aggiornamenti eseguiti nel ramo Git locale.

Prerequisiti

Seguire questa procedura per eseguire la migrazione delle pagine Markdown da un altro wiki al wiki del progetto team o al contenuto pubblicato come codice in un wiki.

Clonare il wiki

Il repository wiki archivia pagine, immagini, allegati e la sequenza di pagine e pagine secondarie. Clonare il wiki per iniziare.

  1. Accedere al progetto (https://dev.azure.com/{Your_Organization/Your_Project}) e quindi selezionare il wiki.

  2. Aprire il menu di scelta rapida Altre azioni e selezionare Clona wiki.

    Clonare il repository Git wiki

  3. Nella finestra di dialogo Clona repository selezionare Copia URL clone negli Appunti.

    Copiare l'URL wiki

    Immetterlo nel browser per visualizzare i file definiti nel ramo wikiMaster.

    File principali wiki

  4. Usare l'URL copiato per clonare il repository nell'IDE usato. Per altre informazioni, vedere uno degli articoli seguenti:

Aggiungere pagine al repository Git locale

Le pagine vengono create usando il formato Markdown. Aggiungere un file Markdown al ramo locale per ogni pagina e pagina secondaria da aggiungere al wiki.

Aggiungere pagine

Per aggiungere pagine nella radice dell'albero wiki, aggiungere un file Markdown nella radice del repository Git.

  1. Per ogni pagina da aggiungere, creare un file Markdown con il contenuto della pagina e aggiungerlo nella cartella radice del repository.

    Per il progetto team CanaryBuilds, si trova nella cartella seguente:

    C:\Users\UserName\Source\Repos\CanaryBuilds.wiki

  2. Per aggiungere pagine nella radice dell'albero wiki, aggiungere un file Markdown per ogni pagina nella radice del repository Git.

    Repository Git wiki del ramo locale

  3. Dopo aver aggiunto tutte le pagine da aggiungere alla radice, aggiornare il file con estensione order nella radice. Deve avere una voce per ogni file Markdown definito nella radice. Ogni voce deve corrispondere al titolo del file con spazi sostituiti con un trattino.

    Ad esempio:

     Welcome
 Roadmap  
 How-to-contribute  
 Home  
 Reference

Aggiungere pagine secondarie

  1. Creare una cartella per la pagina padre e quindi aggiungere i file Markdown per ogni pagina secondaria nella cartella.

    Ad esempio, sono stati aggiunti i file seguenti alla cartella How-to-contribute. Queste pagine secondarie vengono visualizzate nella pagina Come contribuire nel wiki.

    Screenshot delle pagine secondarie.

  2. Aggiungere un file con estensione order nella cartella con l'ordine delle pagine secondarie come dovrebbero essere visualizzate nel wiki. Per comprendere l'uso del file con estensione order per sequenziare le pagine, vedere File del repository Git wiki e struttura di file.

    Ad esempio, il file include le pagine secondarie seguenti:

     Request-extensions  
 Licensing  
 Smoke-test  
 Coding-guidelines

Eseguire il push delle modifiche

Al termine di tutti gli aggiornamenti, eseguire il push dei file nel repository Git.

Le pagine aggiunte e le pagine secondarie vengono visualizzate immediatamente nel wiki.

Albero wiki aggiornato

Se si verificano errori nel processo, le pagine vengono visualizzate nel wiki con un segno di avviso.

Avviso quando il file con estensione order non viene aggiornato correttamente.