Ingerichte wiki versus gepubliceerd als codewiki
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
U kunt uw wiki-inhoud in een teamprojectwiki of een gepubliceerde als codewiki onderhouden. Met een gepubliceerde als codewiki kunt u verschillende versiewiki's onderhouden ter ondersteuning van uw inhoudsbehoeften, hoewel deze alleen beschikbaar is als Azure-opslagplaatsen zijn ingeschakeld.
Hoewel beide opties de wiki-inhoud in Git-opslagplaatsen behouden, verschilt de manier waarop u de wiki-inhoud toevoegt, bijwerkt en beheert.
Notitie
De gepubliceerde wikifunctie als code is momenteel beschikbaar op Azure DevOps Server 2018 en nieuwere versies. Voor oudere versies kunt u alleen een wiki inrichten voor uw teamproject.
Menuopties voor wikipagina's
Met een ingerichte wiki kunt u pagina's rechtstreeks in de wiki toevoegen en bewerken. Alle inhoudsupdates voor een ingerichte wiki vinden plaats in de wiki.
Met een gepubliceerde als codewiki kunt u inhoud toevoegen, bewerken en bijwerken vanuit opslagplaatsen of code.
In de volgende afbeelding ziet u opties voor een ingerichte wiki. Verschillende van deze opties worden niet ondersteund voor de gepubliceerde als codewikipagina's .
Met de optie Bewerken in opslagplaatsen voor de gepubliceerde als codewiki gaat u bijvoorbeeld naar de pagina Opslagplaats om die specifieke pagina te bewerken. Updates die u aanbrengt op een pagina in de vertakking die u voor de wiki hebt geselecteerd, worden automatisch gepubliceerd naar de wiki.
Ondersteunde functies en operationele verschillen
Beide typen wiki ondersteunen de volgende functies:
- Markdown-indeling
- HTML-tags
- Afbeeldingen invoegen en het formaat ervan wijzigen
- Wiskundige notatie en tekens
- Koppelen aan werkitems met #
- Bestanden bijvoegen
- Wiki-inhoud filteren
- Een wikipagina afdrukken
- Inhoud offline bijwerken
- Pagina's toevoegen of bewerken vanuit de Wiki
De volgende tabel bevat een overzicht van de bewerkingen of functies die kunnen verschillen, afhankelijk van het wikitype.
Operation | Ingerichte wiki | Gepubliceerd als codewiki |
---|---|---|
Ondersteuning voor meerdere wiki's, naamwiki | ✔️ | |
Pagina's toevoegen of bewerken vanuit opslagplaatsbestanden> of codebestanden> | ✔️ | |
Teruggaan naar een eerdere revisie vanuit de Wiki | ✔️ | |
Teruggaan naar een eerdere revisie vanuit opslagplaatsen of code | ✔️ | ✔️ |
Versie-wiki's onderhouden | ✔️ | |
Een wikiversie selecteren | ✔️ | |
Publicatie van een codewiki ongedaan maken | ✔️ |
Pagina's toevoegen
Voor beide typen wiki selecteert u Nieuwe pagina of Subpagina toevoegen. Zie Wikipagina's toevoegen en bewerken voor meer informatie.
Paginareeks en paginalijst in navigatiedeelvenster
De ingerichte wiki beheert de paginareeks en paginalijst automatisch wanneer u pagina's toevoegt of verplaatst in het navigatiedeelvenster.
Als u de lijst met pagina's in het navigatiedeelvenster voor een gepubliceerde als codewiki wilt structuren, definieert u het *.order*
bestand in de hoofdmap en voor elke submap of bovenliggende pagina die subpagina's bevat.
Beide typen wiki's volgen dezelfde bestandsstructuur, het is alleen dat de gepubliceerde als codewiki vereist dat u de paginareeks handmatig onderhoudt.
Zie Wiki Git-opslagplaatsbestanden en bestandsstructuur voor meer informatie over het werken met .order
bestanden.
Paginarevisies en terugkeren naar een vorige versie
Vanuit de wiki kunt u de revisies van elke wikipagina bekijken. Selecteer Revisies of de menuoptie Revisies weergeven.
Maar het terugdraaien verschilt afhankelijk van het wikipaginatype.
- Voor een ingerichte wikipagina selecteert u Terugkeren, zoals wordt beschreven in Doorvoeren herstellen naar een ingerichte wikipagina
- Voor een gepubliceerde wikipagina als code werkt u vanuit een lokale vertakking en verzendt u een pull-aanvraag om de vertakking van waaruit u werkt bij te werken.
Versiebeheer en publicatie van een wiki ongedaan maken
Met versiebeheer kunt u verschillende inhoudsversies publiceren naar verschillende wiki's, op basis van een versievertakking van een Git-opslagplaats. U kunt een wiki alleen versie geven en de publicatie ervan ongedaan maken als u degene bent die deze heeft gemaakt door code naar een wiki te publiceren. Zie Publicatie van een codewiki ongedaan maken voor meer informatie.
Een projectwiki verwijderen
Notitie
Wiki REST API's bieden geen ondersteuning voor het verwijderen van een projectwiki. Daarom moet u in plaats daarvan de wikiopslagplaats verwijderen.
Kloon de wikiopslagplaats om een back-up van alle inhoud te maken. De meer opties hebben de kloonw-URL, die kan worden gebruikt om de wiki te klonen.
Haal de git-opslagplaats-id op die uw wiki back-ups maakt. U kunt de REST API gebruiken om alle wiki's in het project op te halen.
Retourneert bijvoorbeeld
GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1
alle wiki's in het project, zodat u kunt kiezen welke u wilt verwijderen.Gebruik de REST API om de Backing Git-opslagplaats te verwijderen. Gebruik de opslagplaats-id van de projectwiki die u in de vorige stap hebt gevonden en controleer de opslagplaats-id, zodat u de verkeerde niet verwijdert.
Bijvoorbeeld
DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1
Een wiki offline bijwerken
U kunt offline of in een lokale vertakking werken om inhoud voor een ingerichte wiki bij te werken en als codewiki te publiceren. Zie Wikipagina's offline klonen en bijwerken voor meer informatie.