Dela via


Klona och uppdatera wiki-innehåll offline

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

Processen för att uppdatera wiki offline är densamma som att utveckla kod på en Git-lagringsplats. Du kan använda de klient- och git-kommandoradsverktyg som du föredrar för att uppdatera dina wiki-sidor offline. Mer information om hur du arbetar med Git-lagringsplatser och verktyg som stöds finns i Git-dokumentationen för Azure Repos.

De grundläggande stegen för att uppdatera wiki-innehåll offline är:

  1. Klona din Wiki Git-lagringsplats till din lokala interaktiva utvecklingsmiljö (IDE) eller arbetsyta.

  2. Lägg till filer eller mappar i din lokala Git-lagringsplatsgren.

  3. Uppdatera .order-filerna så att de återspeglar sekvensändringarna för sidor och undersidor.

  4. Commit:a och pusha uppdateringarna till din lokala Git-gren.

Förutsättningar

Kategori Krav
Projektåtkomst Medlem i projektet där wiki-filerna finns. Du kan begära åtkomst från projektadministratören efter behov.
behörigheter - Medlem i -gruppen bidragsgivare.
– Om du vill publicera kod som wiki skapar du behörigheten Skapa lagringsplats . Som standard anges den här behörigheten för medlemmar i gruppen projektadministratörer.
Åtkomstnivåer Minst grundläggande åtkomst.
Uppgifter - Förstå den underliggande strukturen för din Wiki Git-lagringsplats.
– Förstå skillnaderna mellan en etablerad wiki och en publicerad kod som wiki.

Klona din wiki

Wiki-lagringsplatsen lagrar sidor, bilder, bifogade filer och sekvensen med sidor och undersidor. Klona wikin för att börja.

  1. Logga in på projektet (https://dev.azure.com/<Organization>/<Project>).

  2. Välj din wiki och välj sedan Fler åtgärder (...) >Klona wiki:

    Skärmbild som visar hur du väljer git-åtgärden Fler alternativ Klona wiki för den valda wikin.

  3. I dialogrutan Klona lagringsplats väljer du ikonen Kopiera klonings-URL till Urklipp :

    Skärmbild som visar wiki-lagringsplatsen som ska klonas i dialogrutan Klona lagringsplats.

  4. Klistra in URL:en i webbläsaren. Sidan Git-lagringsplats öppnas där du kan visa de filer som definierats under wikiMain-grenen. I följande exempel visas filerna i Git-lagringsplatsen för CanaryBuilds-projektet:

    Skärmbild som visar Git-lagringsplatsens sida med de filer som definierats under wikiMain-grenen.

    Viktig

    Funktionen Generera Git-autentiseringsuppgifter planeras att tas bort. Läs dokumentationen för Git-autentisering för alla autentiseringsmetoder som är tillgängliga för git-kloningsåtgärder.

  5. Använd den URL som du kopierade för att klona lagringsplatsen i önskad IDE. Mer information finns i följande artiklar:

Lägga till sidor i din lokala Git-lagringsplats

Git-lagringsplatsens sidor formateras som Markdown-filer (.md). För varje sida som du vill lägga till i din wiki skapar du en Markdown-fil i din lokala gren. När du har lagt till sidor uppdaterar du .order-filen för att justera sidsekvensen så att den innehåller de nya sidorna.

Lägg till sidor

Du kan lägga till sidor överst i wiki-strukturen i rotmappen (\) och även i andra mappar.

  1. Skapa Markdown-filen (.md) med innehållet för den nya sidan. I de flesta fall matchar filnamnet sidrubriken. I filnamnet ersätter du alla blanksteg i rubriken med bindestreck (-). Mer information om hur du skapar sidinnehåll finns i Lägg till en wiki-sida.

  2. Placera filen i önskad mapp i wiki-strukturen i din lokala gren, till exempel rotmappen. Rotmappen för CanaryBuilds-projektet är C:\Users\UserName\Source\Repos\CanaryBuilds.wiki:

    Skärmbild som visar den lokala grenen av Wiki Git-lagringsplatsen för CanaryBuilds-projektet.

  3. Uppdatera .order-filen i samma mapp där du placerade den nya sidfilen. Starttexten för sidan är filnamnet utan Markdown-tillägget (.md). I projektexemplet CanaryBuilds läggs den nya sidan "How to contribute" till, vilket motsvarar posttexten How-to-contribute:

    Welcome
    Roadmap  
    How-to-contribute  
    Home  
    Reference  
    

    Mer information om .order-filen finns i Sidsekvens och .order-filen.

Lägg till undersidor

Du kan också skapa undersidor för en sida i wikin:

  1. Skapa en mapp som ska fungera som överordnad sida. Mer information finns i Lagringsplatsfiler och mappstruktur.

  2. Skapa Markdown-filen för varje undersida och placera filen i den överordnade sidmappen. Projektexemplet CanaryBuilds lägger till mappen How-to-contribute som överordnad sida:

    Skärmbild som visar mappen How-to-contribute i CanaryBuilds-projektet med nya undersidor.

  3. Skapa en .order-fil i den överordnade sidmappen för att definiera sekvensen för undersidorna som de ska visas i wikin. Exemplet visar en möjlig ordning på undersidor:

    Request-extensions  
    Licensing  
    Smoke-test  
    Coding-guidelines  
    

Överför dina ändringar

När dina lokala uppdateringar är klara skickar du filerna till Git-lagringsplatsen.

De tillagda sidorna och undersidorna visas omedelbart i wikin. I följande exempel visas uppdateringarna för CanaryBuilds-projektet:

Skärmbild som visar den uppdaterade wiki-strukturen för CanaryBuilds-projektet.

Om det finns fel i processen visas sidan i din wiki-fillista med en varningssymbol :

Skärmbild som visar en sida med ett fel enligt varningssymbolen.