Verwenden eines Texteditors in Ihrer lokalen Umgebung, um die Seite mit der Quellendokumentation zu erstellen.

In diesem Dokument erfahren Sie, wie Sie mit Ihrer lokalen Umgebung die Dokumentation für Ihre Quelle erstellen und eine Pull-Anforderung (PA) senden können.

TIP
Die folgenden Dokumente aus dem Adobe Contributing Guide können zur weiteren Unterstützung Ihres Dokumentationsprozesses verwendet werden:

Voraussetzungen

Für das folgende Tutorial muss GitHub Desktop auf Ihrem lokalen Computer installiert sein. Wenn Sie nicht über GitHub Desktop verfügen, können Sie die Anwendung herunterladen here.

Stellen Sie eine Verbindung zu GitHub her und richten Sie Ihre lokale Authoring-Umgebung ein.

Der erste Schritt bei der Einrichtung Ihrer lokalen Authoring-Umgebung besteht darin, zur Adobe Experience Platform GitHub-Repository.

platform-repo

Wählen Sie auf der Hauptseite des Platform GitHub-Repositorys die Option Verzweigung.

Abspaltung

Um das Repository auf Ihrem lokalen Computer zu klonen, wählen Sie Code. Wählen Sie im angezeigten Dropdown-Menü die Option HTTPS und wählen Sie dann Öffnen mit GitHub Desktop.

TIP
Weitere Informationen finden Sie im Tutorial zu Lokales Einrichten des Git-Repositorys zur Dokumentation.

open-git-desktop

Anschließend lassen Sie GitHub Desktop einige Momente zu, um die experience-platform.en Repository.

Klonen

Sobald der Klonprozess abgeschlossen ist, wechseln Sie zu GitHub Desktop , um eine neue Verzweigung zu erstellen. Auswählen Master aus der oberen Navigation und wählen Sie dann Neuer Zweig

new-branch

Geben Sie im angezeigten Popover-Bedienfeld einen beschreibenden Namen für die Verzweigung ein und wählen Sie dann Zweig erstellen.

create-branch-vs

Wählen Sie als Nächstes Veröffentlichungsverzweigung.

publish-branch

Erstellen Sie die Dokumentationsseite für Ihre Quelle.

Nachdem das Repository auf Ihrem lokalen Computer geklont und eine neue Verzweigung erstellt wurde, können Sie jetzt mit der Erstellung der Dokumentationsseite für Ihre neue Quelle über die Texteditor Ihrer Wahl.

Adobe empfiehlt die Verwendung von Visual Studio-Code und die Adobe Markdown Authoring-Erweiterung installieren. Um die Erweiterung zu installieren, starten Sie Visual Studio Code und wählen Sie dann die Erweiterungen im linken Navigationsbereich.

-Erweiterung

Geben Sie als Nächstes Adobe Markdown Authoring in die Suchleiste ein und wählen Sie Installieren von der angezeigten Seite aus.

install

Laden Sie die Quelldokumentationsvorlage und extrahieren Sie die Datei in experience-platform.en/help/sources/tutorials/api/create/... mit [...] die Kategorie Ihrer Wahl. Wenn Sie beispielsweise eine Datenbankquelle erstellen, wählen Sie den Datenbankordner aus.

Befolgen Sie abschließend die in der Vorlage beschriebenen Anweisungen und bearbeiten Sie die Vorlage mit den entsprechenden Informationen zu Ihrer Quelle.

edit-template

Übermitteln der Dokumentation zur Überprüfung

Um eine Pull-Anforderung (PA) zu erstellen und Ihre Dokumentation zur Überprüfung einzureichen, speichern Sie zunächst Ihre Arbeit in Visual Studio Code (oder Ihres ausgewählten Texteditors). Geben Sie als Nächstes mithilfe von GitHub Desktop eine Commit-Meldung ein und wählen Sie Commit to create-source-documentation.

commit-vs

Wählen Sie als Nächstes Push-Ursprung , um Ihre Arbeit in den Remote-Zweig hochzuladen.

push-origin

Um eine Pull-Anforderung zu erstellen, wählen Sie Pull-Anfrage erstellen.

create-pr-vs

Stellen Sie sicher, dass die Basis- und Vergleichsverzweigungen korrekt sind. Fügen Sie einen Hinweis zur PR hinzu, beschreiben Sie Ihr Update und wählen Sie dann Pull-Anforderung erstellen. Dadurch wird ein PR-Vorgang zum Zusammenführen der Arbeitsverzweigung Ihrer Arbeit mit der Masterverzweigung des Adobe-Repositorys geöffnet.

TIP
Lassen Sie die Zulassen von Änderungen durch Maintainer aktivieren, um sicherzustellen, dass das Adobe-Dokumentationsteam die PR bearbeiten kann.

create-pr

Sie können bestätigen, dass die Pull-Anforderung gesendet wurde, indem Sie die Registerkarte "Pull Requests"in https://github.com/AdobeDocs/experience-platform.en überprüfen.

confirm-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089