Bereitgestelltes Wiki im Vergleich zur Veröffentlichung als Codewiki
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
Sie können Ihre Wiki-Inhalte in einem Teamprojektwiki oder als Codewiki veröffentlicht verwalten. Mit einem als Codewiki veröffentlichten Wiki können Sie mehrere versionsierte Wikis verwalten, um Ihre Inhaltsanforderungen zu unterstützen, obwohl sie nur verfügbar ist, wenn Azure Repos aktiviert ist.
Zwar verwalten beide Optionen den Wiki-Inhalt in Git-Repositorys, doch unterscheidet sich die Art und Weise, wie Sie den Wiki-Inhalt hinzufügen, aktualisieren und verwalten.
Hinweis
Das als Codewiki-Feature veröffentlichte Feature ist derzeit in Azure DevOps Server 2018 und höheren Versionen verfügbar. Bei älteren Versionen können Sie nur ein Wiki für Ihr Teamprojekt bereitstellen.
Menüoptionen für Wiki-Seiten
Mit einem bereitgestellten Wiki können Sie Seiten direkt im Wiki hinzufügen und bearbeiten. Alle Inhaltsaktualisierungen für ein bereitgestelltes Wiki erfolgen innerhalb des Wikis.
Mit einem als Codewiki veröffentlichten Code können Sie Inhalte aus Repos oder Code hinzufügen, bearbeiten und aktualisieren.
Die folgende Abbildung zeigt Optionen für ein bereitgestelltes Wiki. Einige dieser Optionen werden für die als Codewikiseiten veröffentlichten Optionen nicht unterstützt.
Beispielsweise gelangen Sie mit der Option "In Repos bearbeiten" für das als Codewiki veröffentlichte Option zur Seite "Repository ", um diese bestimmte Seite zu bearbeiten. Aktualisierungen, die Sie an einer Seite in der Für das Wiki ausgewählten Verzweigung vornehmen, werden automatisch im Wiki veröffentlicht.
Unterstützte Features und Betriebsunterschiede
Beide Wiki-Typen unterstützen die folgenden Features:
- Markdown-Format
- HTML-Tags
- Einfügen und Ändern der Größe von Bildern
- Mathematische Schreibweise und Zeichen
- Verknüpfen mit Arbeitsaufgaben mithilfe von #
- Dateien anfügen
- Filtern von Wiki-Inhalten
- Drucken einer Wiki-Seite
- Offline aktualisieren von Inhalten
- Hinzufügen oder Bearbeiten von Seiten aus dem Wiki
In der folgenden Tabelle sind die Vorgänge oder Features zusammengefasst, die je nach Wiki-Typ unterschiedlich sein können.
Vorgang | Bereitgestelltes Wiki | Als Codewiki veröffentlicht |
---|---|---|
Unterstützen mehrerer Wikis, Namenswiki | ✔️ | |
Hinzufügen oder Bearbeiten von Seiten aus Repos>Files oder Code Files> | ✔️ | |
Wiederherstellen einer früheren Überarbeitung aus dem Wiki | ✔️ | |
Wiederherstellen einer früheren Überarbeitung von Repos oder Code | ✔️ | ✔️ |
Verwalten von versionsierten Wikis | ✔️ | |
Auswählen einer Wiki-Version | ✔️ | |
Aufheben der Veröffentlichung eines Codewikis | ✔️ |
Seiten hinzufügen
Wählen Sie für beide Wiki-Typen die Option "Neue Seite " oder "Unterseite hinzufügen" aus. Weitere Informationen finden Sie unter Hinzufügen und Bearbeiten von Wiki-Seiten.
Seitensequenz und Seitenliste im Navigationsbereich
Das bereitgestellte Wiki verwaltet die Seitensequenz und die Seitenliste automatisch, wenn Sie Seiten innerhalb des Navigationsbereichs hinzufügen oder verschieben.
Um die Liste der Seiten im Navigationsbereich für ein als Codewiki veröffentlichtes Element zu strukturieren, definieren Sie die *.order*
Datei im Stammverzeichnis und für jeden Unterordner oder jede übergeordnete Seite, die Unterseiten enthält.
Beide Arten von Wikis folgen derselben Dateistruktur, es ist nur, dass das als Codewiki veröffentlichte Wiki erfordert, dass Sie die Seitensequenz manuell verwalten müssen.
Weitere Informationen zum Arbeiten mit .order
Dateien finden Sie unter Wiki Git Repository-Dateien und Dateistruktur.
Seitenrevisionen und Wiederherstellen einer früheren Version
Im Wiki können Sie die Überarbeitungen einer beliebigen Wiki-Seite anzeigen. Wählen Sie "Überarbeitungen " oder die Menüoption "Überarbeitungen anzeigen" aus.
Der Wiederherstellungsvorgang unterscheidet sich jedoch je nach Wiki-Seitentyp.
- Wählen Sie für eine bereitgestellte Wiki-Seite die Option "Zurücksetzen" aus, wie unter "Commit zurücksetzen" auf eine bereitgestellte Wiki-Seite beschrieben.
- Bei einer als Codewiki-Seite veröffentlichten Seite arbeiten Sie von einer lokalen Verzweigung aus, und senden Sie eine Pullanforderung, um die Verzweigung zu aktualisieren, von der Sie gerade arbeiten.
Versionsverwaltung und Aufheben der Veröffentlichung eines Wikis
Mit der Versionsverwaltung können Sie verschiedene Inhaltsversionen auf unterschiedlichen Wikis veröffentlichen, basierend auf einem versionsbasierten Verzweigung eines Git-Repositorys. Sie können ein Wiki nur dann versionieren und wiederveröffentlicht, wenn Sie es durch Veröffentlichen von Code in einem Wiki erstellt haben. Weitere Informationen finden Sie unter Aufheben der Veröffentlichung eines Codewikis.
Löschen eines Projektwikis
Hinweis
Wiki-REST-APIs unterstützen das Löschen eines Projektwikis nicht. Daher müssen Sie stattdessen das Wiki-Repository löschen.
Klonen Sie das Wiki-Repository, um die Sicherung aller Inhalte zu übernehmen. Die "Weitere Optionen" enthält die Klon-Wiki-URL, die zum Klonen des Wikis verwendet werden kann.
Rufen Sie die Git-Repository-ID ab, die Ihr Wiki zurückgibt. Sie können die REST-API verwenden, um alle Wikis im Projekt abzurufen.
Gibt beispielsweise
GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1
alle Wikis im Projekt zurück, sodass Sie auswählen können, welches gelöscht werden soll.Verwenden Sie die REST-API, um das zugrunde stehenden Git-Repository zu löschen. Verwenden Sie die Repository-ID des Projektwikis, das Sie im vorherigen Schritt gefunden haben, und überprüfen Sie die Repository-ID, sodass Sie nicht das falsche entfernen.
Beispiel:
DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1
Aktualisieren eines Wikis offline
Sie können offline oder in einer lokalen Verzweigung arbeiten, um Inhalte für ein bereitgestelltes Wiki zu aktualisieren und als Codewiki zu veröffentlichen. Weitere Informationen finden Sie unter Klonen und Aktualisieren von Wiki-Seiten offline.