Erstellen eines Wikis für ein Projekt

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

In diesem Artikel erfahren Sie, wie Sie ein Wiki öffnen und ein Git-Repository für Ihr Wiki erstellen. Jedes Teamprojekt verfügt über ein Wiki. Verwenden Sie das Wiki, um Informationen mit Ihrem Team zu teilen, um Ihr Projekt zu verstehen und mitzuwirken.

Jedes Teamprojektwiki wird von einem Git-Repository im Back-End unterstützt. Wenn Sie ein Teamprojekt erstellen, wird standardmäßig kein Wiki Git-Repository erstellt. Erstellen Sie ein Git-Repository, um Ihre Wiki-Markdown-Dateien zu speichern, oder veröffentlichen Sie vorhandene Markdown-Dateien aus einem Git-Repository in einem Wiki.

Voraussetzungen

• Sie müssen über ein Teamprojekt verfügen. Wenn Sie noch kein Teamprojekt haben, erstellen Sie ein Teamprojekt in Azure DevOps.
• Sie müssen mindestens über grundlegenden Zugriff verfügen, um ein Wiki zu erstellen und zu ändern.
• Sie müssen über die Berechtigung " Repository erstellen" verfügen, um Code als Wiki zu veröffentlichen. Standardmäßig wird diese Berechtigung für Mitglieder der Gruppe Projektadministratoren festgelegt.
• Jedes Mitglied der Sicherheitsgruppe „Mitwirkende“ kann Wiki-Seiten hinzufügen oder bearbeiten. Jeder Benutzer mit Zugriff auf das Teamprojekt, einschließlich Projektbeteiligten, kann das Wiki anzeigen.

Öffnen des Wikis

Sie können eine Wiki-Seite für Ihr Projekt öffnen und anzeigen.

Browser

Stellen Sie mithilfe eines unterstützten Webbrowsers eine Verbindung mit Ihrem Projekt her, und wählen Sie Wiki aus.

Wenn Sie Ihr Teamprojekt wechseln müssen, wählen Sie Azure DevOps aus, um alle Teamprojekte und Teams zu durchsuchen.

Erste Schritte mit der Azure DevOps-CLI

Sie können eine wiki-Seite anzeigen und öffnen, die für ein Projekt definiert ist, indem Sie den az devops wiki show Befehl verwenden. Informationen zu den ersten Schritten finden Sie unter Erste Schritte mit der Azure DevOps CLI.

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

Parameter

• --wiki: Erforderlich. Name oder ID des Wikis.
• --open: Optional. Öffnen Sie die Wikiseite in Ihrem Webbrowser.
• --project -p: Optional. Name oder ID des Projekts.
• --subscription: Optional. Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Beispiel

Öffnen Sie ein Wiki mit dem Namen "myprojectwiki".

az devops wiki show --wiki myprojectwiki --open

Anzeigen einer Wikiseite

Geben Sie den Befehl ein, az devops wiki show um den Inhalt einer Seite über die Azure DevOps CLI abzurufen.

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

Parameter

• --path: Erforderlich. Pfad der Wiki-Seite.
• --wiki: Erforderlich. Name oder ID des Wikis.
• --include-content: Optional. Fügen Sie den Inhalt der Seite ein.
• --open: Optional. Öffnen Sie die Wikiseite in Ihrem Webbrowser.
• --project -p: Optional. Name oder ID des Projekts.
• --version -v: Optional. Version (ETag) der Wikiseite.

Beispiel

Abrufen von Wiki-Seiteninhalten mit dem Pfad "mein Wiki" in einem Wiki mit dem Namen "myprojectwiki".

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

Erstellen eines Wiki-Git-Repositorys

Browser

Erstellen Sie ein neues Git-Repository, in dem alle Wiki-Seiten und zugehörige Artefakte gespeichert werden. Wählen Sie auf der Wiki-Zielseite " Projekt erstellen" aus. Auch wenn Sie TFVC für die Quellcodeverwaltung verwenden, können Sie ein Wiki mit einem Git-Repository erstellen.

Wenn Sie keinen Zugriff haben, um ein Wiki-Git-Repository zu erstellen oder wenn Sie keinen Zugriff auf eines der vorhandenen Wikis haben, wird die folgende Meldung angezeigt.

Ihr Administrator kann das Wiki-Git-Repository erstellen oder Sie können anfordern, dass er Ihre Berechtigungen erhöht. Projektbeteiligte können kein Wiki erstellen, da sie keine Berechtigungen zum Arbeiten in Repos oder Code haben.

Das Git-Repository des Wikis wird als TeamProjectName.wiki. Wenn Ihr Teamprojekt foobar beispielsweise lautet, wird das Wiki-Repository mit der Bezeichnung versehen foobar.wiki.

Hinweis

Wenn Sie weitere Wikis erstellen möchten, müssen Sie Code als Wiki veröffentlichen. Sie können mehrere Wiki-Repositorys innerhalb eines einzelnen Projekts einrichten.

Wie kann ich zum Git-Repository wechseln?

Das TeamProjectName.wiki wird nicht im Dropdownmenü von Repositorys aus "Repos " oder "Code" angezeigt. Sie befindet sich auch nicht in der Liste, die von den Projekteinstellungen-Repositorys > oder den Versionssteuerungsseiten für Projekteinstellungen > bereitgestellt wird.
Sie können jedoch über die folgende URL darauf zugreifen:

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

Wählen Sie "Wiki klonen" aus den Auslassungspunkten in der Nähe der Wiki-Auswahl aus, um auf die Wiki-URL zuzugreifen.

Die URL des Wiki-Git-Repositorys wird verfügbar gemacht. Kopieren Sie es, und fügen Sie sie in Ihren Webbrowser ein, um auf das zugrunde liegende Git-Repository zuzugreifen.

Erste Schritte mit der Azure DevOps-CLI

Sie können ein Wiki mit dem Befehl "az devops wiki create " erstellen. Informationen zu den ersten Schritten finden Sie unter Erste Schritte mit Azure DevOps CLI.

Hinweis

Um mehr als ein Wiki zu erstellen, müssen Sie Code als Wiki veröffentlichen. Sie können mehrere Wiki-Repositorys innerhalb eines einzelnen Projekts einrichten.

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

Parameter

• zugeordneter Pfad: (Erforderlich für den Codewiki-Typ ). Zugeordneter Pfad des neuen Wikis. Sie können z. B. angeben / , dass sie aus dem Stammverzeichnis des Repositorys veröffentlicht werden sollen.
• name: (Erforderlich für den Codewiki-Typ ). Name des neuen Wikis. Wenn Sie keinen Namen für den Typ "projectwiki" angeben, wird das neue Wiki benannt TeamProjectName.wiki.
• org: URL der Azure DevOps-Organisation. Sie können die Standard-organization mit az devops configure -d organization=ORG_URLkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird. Beispiel: --org https://dev.azure.com/MyOrganizationName/.
• project: Name oder ID des Projekts. Sie können das Standardprojekt mit az devops configure -d project=NAME_OR_IDkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird.
• Repository: (Erforderlich für den Codewiki-Typ ). Name oder ID des Repositorys, aus dem das Wiki veröffentlicht werden soll.
• type: Type of wiki to create. Die akzeptierten Werte sind projectwiki (Standard) und Codewiki.
• version: (Erforderlich für den Codewiki-Typ ). Repository branch name to publish the code wiki from.

Beispiel

Mit dem folgenden Befehl wird ein Wiki namens "Fabrikam Fiber" erstellt und die Ausgabe im Tabellenformat angezeigt.

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

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

Nächste Schritte

Hinzufügen und Bearbeiten von Wiki-Seiten