Freigeben über


Klonen und Aktualisieren von Wiki-Inhalten offline

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

Der Prozess zum Aktualisieren von Wiki-Offline ist identisch mit dem Entwickeln von Code in einem Git-Repository. Sie können Ihre bevorzugten Client- und Git-Befehlszeilentools verwenden, um Ihre Wiki-Seiten offline zu aktualisieren. Ausführliche Informationen zum Arbeiten mit Git-Repositorys und unterstützten Tools finden Sie in der Azure Repos Git-Dokumentation.

Die grundlegenden Schritte zum Offlineupdate von Wiki-Inhalten umfassen:

  1. Klonen Sie Ihr Wiki Git-Repository in Ihre lokale interaktive Entwicklungsumgebung (IDE) oder Ihren Arbeitsbereich.

  2. Fügen Sie Ihrer lokalen Git-Repositoryverzweigung Dateien oder Ordner hinzu.

  3. Aktualisieren Sie die ORDER-Dateien , um die Sequenzänderungen für Seiten und Unterseiten widerzuspiegeln.

  4. Committen und pushen Sie die Updates in Ihren lokalen Git-Branch.

Voraussetzungen

Kategorie Anforderungen
Projektzugriff Mitglied des Projekts, in dem sich die Wikis befinden. Sie können den Zugriff von Ihrem Projektadministrator bei Bedarf anfordern.
Erlaubnisse - Mitglied der Gruppe Mitwirkende.
– Um Code als Wiki zu veröffentlichen, benötigen Sie die Berechtigung Repository erstellen. Diese Berechtigung ist standardmäßig für Mitglieder der Gruppe Projektadministratorenfestgelegt.
Zugriffsebenen Mindestens Grundlegender Zugriff.
Aufgaben - Grundlegendes zur zugrunde liegenden Struktur Ihres Git-Repositorys für Wikis.
- Verstehen der Unterschiede zwischen einem bereitgestellten Wiki und einem veröffentlichten Code als Wiki.

Klonen Ihres Wikis

Ihr Wiki-Repository speichert Seiten, Bilder, Anlagen und die Abfolge von Seiten und Unterseiten. Klonen Sie Ihr Wiki, um zu beginnen.

  1. Melden Sie sich bei Ihrem Projekt (https://dev.azure.com/<Organization>/<Project>).

  2. Wählen Sie Ihr Wiki und dann "Weitere Aktionen " (...) aus. >Wiki klonen:

    Screenshot, der zeigt, wie Sie die Aktion

  3. Wählen Sie im Dialogfeld "Repository klonen" das Symbol "Klon-URL in die Zwischenablage kopieren" aus:

    Screenshot des Wiki-Repositorys, das im Dialogfeld

  4. Fügen Sie die URL in Ihren Browser ein. Die Git-Repositoryseite wird geöffnet, auf der Sie die unter der WikiMain-Verzweigung definierten Dateien anzeigen können. Das folgende Beispiel zeigt die Dateien im Git-Repository für das CanaryBuilds-Projekt:

    Screenshot der Git-Repositoryseite mit den dateien, die unter der WikiMain-Verzweigung definiert sind.

    Wichtig

    Das Feature "Git-Anmeldeinformationen generieren " ist für das Entfernen geplant. Lesen Sie die Dokumentation zur Git-Authentifizierung für alle Authentifizierungsmethoden, die Ihnen für Git-Klonvorgänge zur Verfügung stehen.

  5. Verwenden Sie die URL, die Sie kopiert haben, um das Repository in Ihrer bevorzugten IDE zu klonen. Weitere Informationen finden Sie in den folgenden Artikeln:

Hinzufügen von Seiten zum lokalen Git-Repository

Git-Repositoryseiten werden als Markdown-Dateien (MD) formatiert. Für jede Seite, die Sie Ihrem Wiki hinzufügen möchten, erstellen Sie eine Markdown-Datei in Ihrem lokalen Branch. Nachdem Sie Seiten hinzugefügt haben, aktualisieren Sie die ORDER-Datei , um die Seitensequenz so anzupassen, dass sie die neuen Seiten enthält.

Seiten hinzufügen

Sie können Seiten oben in der Wiki-Struktur im Stammordner (\) und auch in anderen Ordnern hinzufügen.

  1. Erstellen Sie die Markdown-Datei (MD) mit dem Inhalt für die neue Seite. In den meisten Fällen entspricht der Dateiname dem Seitentitel. Ersetzen Sie im Dateinamen alle Leerzeichen im Titel durch Bindestriche (-). Weitere Informationen zum Erstellen von Seiteninhalten finden Sie unter Hinzufügen einer Wiki-Seite.

  2. Platzieren Sie die Datei im gewünschten Ordner in der Wiki-Struktur in Ihrer lokalen Verzweigung, z. B. im Stammordner. Der Stammordner des Beispielprojekts CanaryBuilds lautet C:\Users\UserName\Source\Repos\CanaryBuilds.wiki:

    Screenshot der lokalen Verzweigung des Wiki-Git-Repositorys für das CanaryBuilds-Projekt.

  3. Aktualisieren Sie die ORDER-Datei im selben Ordner, in dem Sie die neue Seitendatei platziert haben. Der Eintragstext für die Seite ist der Dateiname ohne die Markdown-Erweiterung (MD). Im CanaryBuilds-Projektbeispiel wird die neue Seite "Mitwirken" hinzugefügt, die dem Eintragstext " How-to-contribute" entspricht:

    Welcome
    Roadmap  
    How-to-contribute  
    Home  
    Reference  
    

    Weitere Informationen zur ORDER-Datei finden Sie unter "Page sequence" und ".order".

Hinzufügen von Unterseiten

Sie können auch Unterseiten für eine Seite in Ihrem Wiki erstellen:

  1. Erstellen Sie einen Ordner, der als übergeordnete Seite dienen soll. Weitere Informationen finden Sie unter Repositorydateien und Ordnerstruktur.

  2. Erstellen Sie die Markdown-Datei für jede Unterseite, und platzieren Sie die Datei im übergeordneten Seitenordner. Im CanaryBuilds-Projektbeispiel wird der Ordner " How-to-contribute" als übergeordnete Seite hinzugefügt:

    Screenshot des Ordners

  3. Erstellen Sie eine ORDER-Datei im ordner der übergeordneten Seite, um die Sequenz für die Unterseiten zu definieren, wie sie im Wiki angezeigt werden sollen. Das Beispiel zeigt eine mögliche Reihenfolge von Unterseiten:

    Request-extensions  
    Licensing  
    Smoke-test  
    Coding-guidelines  
    

Änderungen pushen

Wenn Ihre lokalen Updates bereit sind, übertragen Sie die Dateien an das Git-Repository.

Die hinzugefügten Seiten und Unterseiten werden sofort in Ihrem Wiki angezeigt. Das folgende Beispiel zeigt die Aktualisierungen für das CanaryBuilds-Projekt:

Screenshot der aktualisierten Wiki-Struktur für das CanaryBuilds-Projekt.

Wenn fehler im Prozess auftreten, wird die Seite in ihrer Wiki-Dateiliste mit einem Warnsymbol angezeigt:

Screenshot einer Seite mit einem Fehler, wie durch das Symbol