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 hier herunterladen.

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

Der erste Schritt beim Einrichten Ihrer lokalen Authoring-Umgebung besteht darin, zum Adobe Experience Platform GitHub-Repository zu navigieren.

platform-repo

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

fork

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

TIP
Weitere Informationen finden Sie im Tutorial zum lokalen Einrichten des Git-Repositorys für die Dokumentation.

open-git-desktop

Lassen Sie als Nächstes einige Augenblicke zu, bis GitHub Desktop das experience-platform.en-Repository klonen kann.

Klonen

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

new-branch

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

create-branch-vs

Wählen Sie als Nächstes Publish-Verzweigung aus.

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 dem Authoring der Dokumentationsseite für Ihre neue Quelle über den Texteditor Ihrer Wahl beginnen.

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

-Erweiterung

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

install

Laden Sie die Dokumentationsvorlage "Quellen""herunter und extrahieren Sie die Datei nach "experience-platform.en/help/sources/tutorials/api/create/...", wobei "[...]" der Kategorie Ihrer Wahl entspricht. 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 zu übermitteln, speichern Sie zunächst Ihre Arbeit in Visual Studio Code (oder Ihrem ausgewählten Texteditor). 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 origin aus, um Ihre Arbeit in den Remote-Zweig hochzuladen.

push-origin

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

create-pr-vs

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

TIP
Lassen Sie das Kontrollkästchen Änderungen durch Betreuer zulassen aktiviert, um sicherzustellen, dass das Adobe-Dokumentationsteam Änderungen an der PA vornehmen 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