Veröffentlichen eines Git-Repositorys in einem Wiki

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

In dieser Schnellstartanleitung erfahren Sie, wie Sie die folgenden Aufgaben ausführen:

  • Wiki öffnen
  • Veröffentlichen eines Git-Repo in einem Wiki
  • Bearbeiten von Seiten eines veröffentlichten Wikis
  • Hinzufügen von Seiten zu einem veröffentlichten Wiki
  • Ändern der Seitensequenz eines veröffentlichten Wikis
  • Erstellen einer Seite zur Wiki-Startseite

Inhalte, die Sie bereits in einem Git-Repository verwalten, können in einem Wiki veröffentlicht werden. Dies kann beispielsweise Inhalte sein, die geschrieben werden, um ein Software Development Kit (SDK), produktdokumentation oder README-Datei zu unterstützen. Sie können mehrere Wikis in einem einzelnen Teamprojekt veröffentlichen.

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

  • Organisieren des Inhalts in eine hierarchische Seitenstruktur
  • Inhaltsverzeichnis, das Leser durchsuchen und filtern können
  • Veröffentlichen neuer Versionen des Inhalts
  • Verwalten von Inhalten auf die gleiche Weise, wie Sie Ihre Codebasis verwalten
  • Leser können das Wiki ganz einfach mithilfe der Wiki-Suchfunktion durchsuchen.

Informationen zum Verwalten der verschiedenen Wiki-Typen finden Sie unter Unterschiede zwischen bereitgestellten Wikis und Veröffentlichen von Code als Wiki.

Tipp

Sie können Inhalte hinzufügen und bearbeiten, die Sie in einem Wiki veröffentlicht haben, indem Sie die in diesem Artikel beschriebenen Schritte verwenden. 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

  • Sie müssen über ein Teamprojekt verfügen. Wenn Sie noch kein Teamprojekt haben, erstellen Sie eins.
  • Sie müssen Azure Repos Dienst für Ihr Projekt aktiviert haben.
  • Sie müssen über ein Git-Repository verfügen, das in Ihrem Teamprojekt definiert ist. Idealerweise enthält dieses Repository mindestens eine Markdown-Datei, die Sie in Ihrem Wiki veröffentlichen möchten. Wenn Sie ein Git-Repository hinzufügen müssen, lesen Sie " Erstellen eines neuen Git-Repo" in Ihrem Projekt.
  • Sie müssen über die Berechtigung "Mitwirken " verfügen, um Code als Wiki zu veröffentlichen. Standardmäßig ist diese Berechtigung für Mitglieder der Gruppe "Mitwirkende" festgelegt.
  • Jeder, der über Berechtigungen verfügt, um zum Git-Repository beizutragen, kann Wiki-Seiten hinzufügen oder bearbeiten.

Wiki öffnen

Beginnen Sie mit der Verbindung mit Ihrem Projekt mit einem unterstützten Webbrowser , und wählen Sie "Wiki" aus.

Wählen Sie "Übersichtswiki" aus>.

Create wiki, provision a Git repo for your wiki, or publish existing repo Markdown files

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

Veröffentlichen eines Git-Repositorys in einem Wiki

Wählen Sie diese Option aus, wenn Sie Markdown-Dateien in einem vorhandenen Git-Repo verwalten und sie in einem Wiki veröffentlichen möchten.

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

    Create wiki, publish existing repo Markdown files

    Hinweis

    Der Code als Wiki-Option wird nicht angezeigt, wenn Ihr Projekt kein Git-Repository definiert hat. Erstellen Sie ein neues Git-Repo, und kehren Sie diese Seite zurück und aktualisieren Sie diese Seite.

    Wenn Sie bereits ein Teamprojektwiki bereitgestellt haben, wählen Sie im Kontextmenü für Wikis die Option "Codewiki veröffentlichen" aus.

    Publish code as wiki menu option

  2. Wählen Sie das Repository, die Verzweigung und den Ordner aus, die die Markdown-Dateien enthalten, und benennen Sie das Wiki-Repository. Das Git-Repo muss sich innerhalb des Teamprojekts befinden.

    Name the wiki repository.

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

  3. Wählen Sie "Veröffentlichen" aus. Das Wiki-Repo wird mit den Markdown-Dateien und Ordnern ausgefüllt, die innerhalb des ausgewählten Repositorys enthalten sind.

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

    Published wiki from existing repo Markdown files

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

    • Jede im Repo/branch/folder definierte Markdown-Datei (Dateityp=.md) wird in alphabetischer Reihenfolge aufgeführt, der TOC-Titel 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.

      Und hier ist ein Bild des Inhalts des Azure-docs-sdk-node-Repositorys.

      Repo with Markdown files published to wiki

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

Hinweis

Sie können bis zu 10 Gesamtwikis veröffentlichen.

Für das Wiki, das mit den hinzugefügten Markdown-Dateien bereitgestellt wird, können Sie jetzt Seiten auf die gleiche Weise hinzufügen oder bearbeiten, wie Sie Code in Ihrem Git-Repository verwalten.

Bearbeiten, Umbenennen oder Löschen von Seiten

  1. Zum Bearbeiten, Umbenennen oder Löschen einer Seite öffnen Sie Repos> Files oder CodeFiles>.

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

    Edit, rename, or delete wiki content

Hinweis

Sie können Ihr Wiki-Repo auf die gleiche Weise verwalten, wie Sie alle anderen Git-Repo verwalten, indem Sie Verzweigungsrichtlinien für die Verzweigung definieren, die Sie für die Veröffentlichung in einem Wiki ausgewählt haben. Ohne definierte Richtlinien können Sie jedoch Änderungen vornehmen und sie direkt über Ihr Webportal oder von einem Client an die Verzweigung senden.

Bearbeiten einer Seite

Sie können die links verwenden, die im Bearbeitungsmodus verfügbar sind, um Ihre Änderungen anzuzeigen oder Änderungen hervorzuheben, die aus der vorherigen Version vorgenommen wurden. Um Ihre Änderungen zu verwerfen, wählen Sie "Abbrechen" aus. Ausführliche Informationen zu unterstützten Markdown-Features finden Sie unter Syntaxanleitungen für die Verwendung von Markdown.

  1. Wenn Sie mit Ihren Updates fertig sind, wählen Sie "Commit" aus, und füllen Sie dann das Dialogfeld "Commit" aus.

    Commit dialog

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

    Create a pull request link

Tipp

Wenn Sie den Namen oder den Fall einer Datei ändern, möchten Sie die Bestelldatei aktualisieren, um die Änderung darzustellen. Um mehr zu erfahren, wechseln Sie zur Änderung der Seitensequenz, fügen oder aktualisieren Sie eine ORDER-Datei.

Umbenennen einer Seite

Alle Seiten, die im TOC angezeigt werden sollen, müssen als Dateityp .md enthalten. Wählen Sie "Umbenennen " aus, um die Datei entsprechend umzubenennen.

Hier benennen wir beispielsweise new-home-page.md um, um New-Home-Page.md zu New-Home-Page.md. Diese Seite wird in der TOC mit der Bezeichnung "Neue Startseite" angezeigt.

Rename Commit dialog

Seitentitel sind groß-vertraulich und müssen innerhalb des Ordners und 235 Zeichen oder weniger eindeutig sein. Weitere Titeleinschränkungen finden Sie unter Einschränkungen für die Benennung von Seitentiteln.

Löschen einer Seite

Alle Markdown-Dateien, die nicht im Wiki angezeigt werden möchten, können Sie aus dem veröffentlichten Ordner löschen. Wenn Sie die Datei in eine ORDER-Datei eingefügt haben, löschen Sie den Eintrag aus der Bestelldatei . Um mehr zu erfahren, wechseln Sie zur Änderung der Seitensequenz, hinzufügen oder aktualisieren Sie eine ORDER-Datei.

Hinzufügen einer Seite oder einer Seite

Sie können Ihren veröffentlichten Wiki wie folgt Seiten hinzufügen:

  • Hinzufügen einer Datei zu einem Stammordner oder Unterordner aus dem Webportal
  • Hochladen Dateien in einem Stammordner oder Unterordner
  • Fügen Sie eine ORDER-Datei hinzu, um die Seitensequenz in der Wiki-TOC anzugeben oder zu aktualisieren.

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

Hinzufügen einer Seite aus dem Webportal

  1. Wählen Sie in Repos> Files oder CodeFiles> für das veröffentlichte Repo Aktionen aus, und wählen Sie dann "Datei" aus.

    Add a page to the wiki from the web portal

  2. Geben Sie einen Namen für die Seite ein, stellen Sie sicher, dass Sie den Dateityp .md angeben. Der Dateiname sollte dem Seitentitel entsprechen, den Sie im TOC mit Strichen anstelle von Leerzeichen anzeigen möchten. Geben Sie einen eindeutigen Titel von 235 Zeichen oder weniger an. Seitentitel sind Groß-/Kleinschreibungen. Weitere Titeleinschränkungen finden Sie unter Einschränkungen für die Benennung von Seitentiteln.

    Wenn Sie beispielsweise eine Seite hinzufügen möchten, die auf dem TOC als Seite 4 angezeigt wird, fügen Sie eine Datei namens Page-4.md hinzu.

    Filter wiki TOC

  3. Geben Sie den Inhalt der Seite ein. Ausführliche Informationen zu unterstützten Markdown-Features finden Sie unter Syntaxanleitungen für Markdown-Dateien, Widgets, Wikis und Pull-Anforderungskommentare.

  4. Wählen Sie "Commit" aus, und füllen Sie dann das Dialogfeld "Commit" aus.

Hochladen Dateien in einem Ordner

  1. Wenn Sie bereits vorhandene Inhalte definiert haben, können Sie sie in einen Ordner hochladen. Wählen Sie "Aktionen" aus, und wählen Sie dann Hochladen Datei(n).

    Upload files to a folder option

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

    Commit dialog for uploading files

Hinzufügen einer übergeordneten Seite und Unterseiten

Um eine übergeordnete Seite hinzuzufügen, fügen Sie zuerst eine Markdown-Datei auf Der Stammordnerebene hinzu, und fügen Sie dann einen Ordner mit derselben Bezeichnung hinzu.

  1. Wenn Sie einen Ordner hinzufügen möchten, 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.

    Create folder dialog

  2. Fügen Sie alle Dateien hinzu, die Sie als Unterseiten zum Ordner hinzufügen möchten.

Hinzufügen oder Aktualisieren einer Bestelldatei

Der letzte Schritt beim Hinzufügen von Dateien oder Ordnern zum Wiki-Repo besteht darin, die Orderdatei der aktualisierten Ordner hinzuzufügen oder zu aktualisieren. Diese Aktion spiegelt die Reihenfolge der Seiten wider, die Sie im TOC anzeigen möchten. Ausführliche Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer Bestelldatei. Alle Dateien, die nicht in der Bestelldatei aufgeführt sind, werden am Ende der alphabetischen Liste hinzugefügt, da die Reihenfolge auf "int" festgelegt ist. 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 Stammreihenfolgedatei gibt die Reihenfolge der Seiten an, die auf Stammebene definiert sind. Und für jeden Ordner definiert eine ORDER-Datei die Sequenz von Unterseiten, die einer übergeordneten Seite hinzugefügt wurden.

Sie können eine ORDER-Datei auf dieselbe Weise hinzufügen, wie Sie eine beliebige Datei auf der CodeFiles-Seite> hinzufügen. Benennen Sie die Datei .order.

Bearbeiten Sie dann den Inhalt der Datei, um die Sequenz von Markdown-Dateien in dem Ordner widerzuspiegeln. Jeder Eintrag sollte den Dateinamen spiegeln, aber ohne den Dateityp .md . Titel sind Groß-/Kleinschreibung, sodass der Eintrag dem in dem Dateinamen verwendeten Fall entspricht.

Beispiel:

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

Festlegen einer Startseite

Standardmäßig wird die erste Datei, die im Stamm in alphabetischer Reihenfolge angezeigt wird, als Wiki-Startseite festgelegt. Die Startseite wird geöffnet, wenn Sie Wiki im Webportal auswählen.

Sie können die Startseite ändern, indem Sie die Seitensequenz in der Stammreihenfolge der Stammreihenfolge 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 bewerben

Für einen Ordner, der auch eine Seite sein soll, sollte eine Markdown-Datei mit demselben Namen wie der Ordner als ein Gleichgeteiler des Ordners vorhanden sein, d. h. sowohl der Ordner als auch die MD-Datei desselben Namens sollte nebeneinander liegen.

Im folgenden Beispiel wird Test sowohl über einen Ordner als auch eine MD-Datei angezeigt, die eine Hierarchie in der Wiki-Struktur erstellt.

Promote a folder to a page

Nächste Schritte