Veröffentlichen eines Git-Repositorys in einem Wiki

  • Artikel

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

Sie können Inhalte veröffentlichen, die Sie bereits in einem Git-Repository in einem Wiki Standard. Beispielsweise kann es sich bei diesem Inhalt um Unterstützung für Software Development Kit (SDK), Produktdokumentation oder eine README-Datei handeln. Sie können auch mehrere Wikis innerhalb eines einzelnen Teamprojekts veröffentlichen.

Wenn Sie Ihre Markdown-Dateien in einem Wiki veröffentlichen, erhalten Sie die folgenden Vorteile:

  • Organisieren des Inhalts in einer hierarchischen Seitenstruktur
  • Durchsuchen und Filtern des Inhaltsverzeichnisses
  • Veröffentlichen neuer Versionen des Inhalts
  • Verwalten von Inhalten auf die gleiche Weise, wie Sie Ihre Codebasis verwalten
  • Einfaches Durchsuchen des Wikis mithilfe der Wiki-Suchfunktion

Weitere Informationen finden Sie unter Bereitgestellter vs. veröffentlichter Code als Wiki.

Tipp

Sie können Inhalte, die Sie in einem Wiki veröffentlicht haben, mithilfe der Schritte in diesem Artikel hinzufügen und bearbeiten. Sie können auch offline arbeiten und Wiki-Inhalte auf die gleiche Weise aktualisieren, wie Sie über ein Git-Repository an Code zusammenarbeiten. Weitere Informationen finden Sie unter "Aktualisieren von Wiki-Seiten offline".

Voraussetzungen

  • Haben Sie ein Teamprojekt. Wenn Sie noch kein Projekt haben, erstellen Sie jetzt ein Projekt .
  • Aktivieren Sie den Azure Repos-Dienst für Ihr Projekt.
  • Sie haben ein Git-Repository in Ihrem Teamprojekt definiert. Im Idealfall enthält dieses Repository mindestens eine Markdown-Datei, die Sie in Ihrem Wiki veröffentlichen möchten. Weitere Informationen finden Sie unter Erstellen eines neuen Git-Repositorys in Ihrem Projekt.
  • Besitzen Sie die Berechtigung "Mitwirken" , um Code als Wiki zu veröffentlichen. Diese Berechtigung ist standardmäßig für Mitglieder der Gruppe "Mitwirkende" festgelegt. Jeder, der über Berechtigungen zum Mitwirken am Git-Repository verfügt, kann Wiki-Seiten hinzufügen oder bearbeiten.

Wiki öffnen

  1. Melden Sie sich bei Ihrer Organisation an (https://dev.azure.com/{yourorganization}), öffnen Sie Ihr Projekt, und wählen Sie dann "Übersichtswiki"> aus.

    Screenshot der Auswahl der Wiki-Registerkarte.

Wenn Sie Projekte wechseln müssen, wählen Sie Azure DevOps aus, um alle Projekte zu durchsuchen.

Veröffentlichen eines Git-Repositorys in einem Wiki

Führen Sie die folgenden Schritte aus, wenn Sie Markdown-Dateien in einem vorhandenen Git-Repository Standard und diese in einem Wiki veröffentlichen möchten.

  1. Wählen Sie "Code veröffentlichen" als Wiki aus.

    Screenshot mit hervorgehobener Schaltfläche, Code als Wiki veröffentlichen.

    Hinweis

    Der Veröffentlichungscode als Wiki-Option wird nicht angezeigt, wenn ihr Projekt kein Git-Repository definiert hat. Erstellen Sie ein neues Git-Repository, und geben Sie diese Seite zurück und aktualisieren Sie sie.

  2. Wenn Sie bereits ein Teamprojektwiki bereitgestellt haben, wählen Sie "Codewiki veröffentlichen" aus.

    Screenshot mit der Menüoption

  3. Wählen Sie das Repository, die Verzweigung und den Ordner aus, die die Markdown-Dateien enthalten, und geben Sie einen Namen für das Wiki-Repository ein. Das Git-Repository muss sich innerhalb des Teamprojekts befinden.

    Screenshot mit dem eingegebenen Namen für das Wiki-Repository.

    Geben Sie den Stamm des Repositorys an, wenn Sie alle Markdown-Dateien im Repository in Ihrem Wiki veröffentlichen möchten.

  4. Wählen Sie Veröffentlichen aus. Das Wiki-Repository füllt mit den Markdown-Dateien und Ordnern auf, die in dem ausgewählten Repository enthalten sind.

    Die folgende Abbildung zeigt beispielsweise das veröffentlichte Repository für die Dateien, die im Azure-docs-sdk-Knoten-Repository enthalten sind, das Sie in Schritt 2 ausgewählt haben.

    Screenshot des veröffentlichten Wikis aus vorhandenen Repository-Markdown-Dateien.

    Das Wiki-Inhaltsverzeichnis (Inhaltsverzeichnis) enthält die folgenden Dateien:

    • Jede im Repository/Verzweigung/Ordner definierte Markdown-Datei (Dateityp= .md) wird alphabetisch aufgelistet, der Inhaltsverzeichnistitel wird vom Namen der Markdown-Datei abgeleitet.

    • Eine übergeordnete Seite für jeden im veröffentlichten Ordner definierten Unterordner, auch wenn er keine Markdown-Dateien enthält.

      Die folgende Abbildung zeigt den Inhalt des Azure-docs-sdk-node-Repositorys.

      Screenshot des Repositorys mit Markdown-Dateien, die in Wiki veröffentlicht wurden.

Der Head of the Git repo branch is mapped to the wiki. Alle änderungen, die innerhalb der Verzweigung und der ausgewählten Ordner vorgenommen wurden, werden automatisch im Wiki angezeigt. Es sind keine anderen Workflows beteiligt.

Hinweis

Sie können bis zu 10 Verzweigungen pro veröffentlichtem Codewiki veröffentlichen.

Für das bereitgestellte Wiki mit den zusätzlichen Markdown-Dateien können Sie Seiten auf die gleiche Weise hinzufügen oder bearbeiten, wie Sie Code in Ihrem Git-Repository Standard.

Bearbeiten, Umbenennen oder Löschen von Seiten

Führen Sie die folgenden Schritte aus, um eine Wiki-Seite zu bearbeiten, um sie umzubenennen oder zu löschen.

  1. Öffnen Sie in Ihrem Projekt "Repos>Files" oder "Code > Files".

  2. Wählen Sie die gewünschte Seite aus, wählen Sie "Aktionen" und dann den Vorgang aus.

    Screenshot der Wiki-Aktionsoptionen,

Hinweis

Verwalten Sie Ihr Wiki-Repository auf die gleiche Weise wie jedes andere Git-Repository, indem Sie Verzweigungsrichtlinien für die Verzweigung definieren, die Sie für die Veröffentlichung in einem Wiki ausgewählt haben. Aber ohne definierte Richtlinien können Sie Änderungen vornehmen und diese direkt über Ihr Webportal oder von einem Client an die Verzweigung übertragen.

Bearbeiten einer -Seite

Verwenden Sie die links, die im Bearbeitungsmodus verfügbar sind, um eine Vorschau Ihrer Änderungen anzuzeigen oder Änderungen hervorzuheben, die aus der vorherigen Version vorgenommen wurden. Wenn Sie die Änderungen aufheben möchten Karte wählen Sie "Abbrechen" aus. Weitere Informationen zu unterstützten Markdown-Features finden Sie unter Syntaxanleitungen für die Markdown-Verwendung.

  1. Wenn Sie fertig sind, fügen Sie einen Kommentar zu Ihren Updates hinzu, und wählen Sie dann "Commit ausführen" aus.

    Screenshot des Dialogfelds

    Das System zeigt Ihnen automatisch einen Link zum Erstellen einer Pullanforderung an. Sie können diese Meldung ignorieren, wenn Sie die Wiki-Verzweigung direkt bearbeiten.

    Screenshot: Erstellen eines Pullanforderungslinks.

Tipp

Wenn Sie den Namen oder die Groß-/Kleinschreibung einer Datei ändern, aktualisieren Sie die .order Datei so, dass sie die Änderung widerspiegelt. Weitere Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei.

Umbenennen einer Seite

Alle Seiten, die im Inhaltsverzeichnis angezeigt werden sollen, müssen der Dateityp .mdsein.

  1. Wählen Sie "Umbenennen " aus, um die Datei entsprechend umzubenennen.

In der folgenden Abbildung wird beispielsweise new-home-page.md in New-Home-Page.md umbenannt. Diese Seite wird im Inhaltsverzeichnis mit der Bezeichnung "Neue Startseite" angezeigt.

Screenshot des Dialogfelds

Bei Seitentiteln wird die Groß-/Kleinschreibung beachtet und muss innerhalb des Ordners und 235 Zeichen oder weniger eindeutig sein. Weitere Informationen zu anderen Titeleinschränkungen finden Sie unter Namensbeschränkungen für Seitentitel.

Eine Seite löschen

Sie können alle Markdown-Dateien löschen, die nicht im Wiki im veröffentlichten Ordner angezeigt werden sollen. Wenn Sie die Datei in eine .order Datei aufgenommen haben, löschen Sie den Eintrag aus der .order Datei. Weitere Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei.

Hinzufügen einer Seite oder Seiten

Sie können Ihrem veröffentlichten Wiki die folgenden Seiten hinzufügen:

  • Hinzufügen einer Datei zu einem Stammordner oder Unterordner aus dem Webportal
  • Hochladen von Dateien in einen Stammordner oder Unterordner
  • Hinzufügen oder Aktualisieren einer .order Datei zum Angeben der Seitensequenz im Wiki-Inhaltsverzeichnis

Jedes Update erfordert, dass Sie Ihre Änderungen an dem Repository übernehmen. Anschließend können Sie Ihr Wiki für Ihr veröffentlichtes Repository aktualisieren, um die Änderungen zu überprüfen.

Hinzufügen einer Seite aus dem Webportal

  1. Wählen Sie unter "Dateien>" oder "Codedateien>" für das veröffentlichte Repository "Aktionen" und dann "Datei" aus.

    Screenshot des Hinzufügens einer Seite zum Wiki aus dem Webportal.

  2. Geben Sie einen Namen für die Seite ein, stellen Sie sicher, dass Sie den .md Dateityp angeben. Der Dateiname sollte dem Seitentitel entsprechen, der im Inhaltsverzeichnis angezeigt werden soll, mit Bindestrichen anstelle von Leerzeichen. Geben Sie einen eindeutigen Titel mit mindestens 235 Zeichen an. Bei Seitentiteln wird die Groß-/Kleinschreibung beachtet. Weitere Informationen zu anderen Titeleinschränkungen finden Sie unter Namensbeschränkungen für Seitentitel.

    Wenn Sie beispielsweise eine Seite hinzufügen möchten, die im Inhaltsverzeichnis als Seite 4 angezeigt wird, fügen Sie eine Datei mit dem Namen hinzu Page-4.md.

    Screenshot des Dialogfelds

  3. Geben Sie den Inhalt der Seite ein. Weitere Informationen finden Sie unter Syntaxanleitungen für Markdown-Dateien, Widgets, Wikis und Pullanforderungskommentare.

  4. Wenn Sie fertig sind, wählen Sie "Commit ausführen" aus.

Hochladen von Dateien in einen Ordner

  1. Wenn Sie bereits vorhandenen Inhalt definiert haben, können Sie ihn in einen Ordner hochladen. Wählen Sie "Aktionen" und dann " Datei hochladen" aus.

    Screenshot mit hervorgehobener Auswahl,

  2. Füllen Sie das Dialogfeld "Commit" aus, und wählen Sie den Ordner und die Dateien aus, die Sie hochladen möchten.

    Screenshot des Dialogfelds

Hinzufügen einer übergeordneten Seite und Unterseiten

Wenn Sie eine übergeordnete Seite hinzufügen möchten, fügen Sie zuerst eine Markdown-Datei auf Stammordnerebene hinzu, und fügen Sie dann einen Ordner mit derselben Bezeichnung hinzu.

  1. Um einen Ordner hinzuzufügen, wählen Sie "Ordner" aus, und füllen Sie dann das Dialogfeld "Neuer Ordner " aus. Geben Sie mindestens eine Datei an, die einer Unterseite im Ordner entspricht.

    Screenshot des Dialogfelds

  2. Fügen Sie dem Ordner alle gewünschten Dateien als Unterseiten hinzu.

Hinzufügen oder Aktualisieren einer ORDER-Datei

Der letzte Schritt beim Hinzufügen von Dateien oder Ordnern zum Wiki-Repository besteht darin, die .order Datei der aktualisierten Ordner hinzuzufügen oder zu aktualisieren. Diese Aktion spiegelt die Reihenfolge der Seiten wider, die im Inhaltsverzeichnis angezeigt werden sollen. Weitere Informationen finden Sie unter Ändern der Seitensequenz, hinzufügen oder aktualisieren Sie eine ORDER-Datei. Alle Dateien, die nicht in der .order Datei aufgeführt sind, werden am Ende der alphabetischen Liste hinzugefügt, da ihre Reihenfolge auf int.MaxValue".

Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei

Jede .order Datei definiert die Reihenfolge der Seiten, die in einem Ordner enthalten sind. Die Stammdatei .order gibt die Reihenfolge der Seiten an, die auf der Stammebene definiert sind. Für jeden Ordner definiert eine .order Datei die Abfolge von Unterseiten, die einer übergeordneten Seite hinzugefügt wurden.

  1. Sie können eine .order Datei auf die gleiche Weise hinzufügen, wie Sie eine beliebige Datei auf der Seite "Codedateien>" hinzufügen. Nennen Sie die Datei .order.

  2. Bearbeiten Sie den Inhalt der Datei, um die Abfolge von Markdown-Dateien im Ordner widerzuspiegeln. Jeder Eintrag sollte den Dateinamen Spiegel, jedoch ohne den .md Dateityp. Bei Titeln wird die Groß-/Kleinschreibung beachtet, daher sollte der Eintrag mit der im Dateinamen verwendeten Groß-/Kleinschreibung übereinstimmen.

Zum Beispiel:

README
page-2
page-3
Page-4
Misc content

Festlegen einer Startseite

Standardmäßig wird die erste Datei, die im Stammverzeichnis innerhalb alphabetischer Reihenfolge angezeigt wird, als Wiki-Startseite festgelegt. Wenn Sie "Wiki" im Webportal auswählen, wird die Startseite geöffnet.

  1. Ändern Sie die Startseite, indem Sie die Seitensequenz in der Stammdatei .order festlegen.

Geben Sie beispielsweise den Seitennamen in die erste Zeile ein.

New home page name here
page-2
page-3
Page-4
README
Misc content

Ordner auf Seite höher stufen

Damit ein Ordner auch eine Seite sein kann, benötigen Sie eine Markdown-Datei mit demselben Namen wie der Ordner, der als gleichgeordnetes Element auf den Ordner festgelegt ist. Daher sollte sowohl der Ordner als auch die .md Datei desselben Namens nebeneinander liegen.

Wie im folgenden Beispiel dargestellt, verfügt Test sowohl über einen Ordner als auch über eine .md Datei, die eine Hierarchie innerhalb der Wiki-Struktur erstellt.

Screenshot der Heraufsufung eines Ordners zu einer Seite.

Auswählen einer Wiki-Version

Um eine Wiki-Version auszuwählen, wählen Sie die Version aus den Verzweigungsoptionen auf der Wiki-Seite aus.

Screenshot einer ausgewählten Wiki-Version aus dem Wiki-Dropdownmenü.

Aufheben der Veröffentlichung eines Codewikis

Wenn Sie nicht mehr möchten, dass ein Repository als Wiki veröffentlicht wird, können Sie die Veröffentlichung aufheben.

Warnung

Wenn Sie die Veröffentlichung eines Wikis aufheben, wird die Veröffentlichung des gesamten Codewikis aufgehoben, das alle Versionen des Repositorys enthält, das Sie zuvor veröffentlicht haben.

  1. Wählen Sie das Wiki aus, das Sie die Veröffentlichung aufheben möchten, öffnen Sie das Kontextmenü, und wählen Sie "Veröffentlichung aufheben" aus.

    Screenshot des Dialogfelds zum Aufheben der Veröffentlichung eines Wiki-Bestätigungsdialogfelds.

  2. Vergewissern Sie sich, dass Sie die Veröffentlichung des Wikis aufheben möchten, indem Sie " Veröffentlichung aufheben" auswählen.

    Screenshot des Aufhebens der Veröffentlichung von Wiki.