Verwenden eines Texteditors in Ihrer lokalen Umgebung, um die Seite mit der Quellendokumentation zu erstellen.
In diesem Dokument wird beschrieben, wie Sie mit Ihrer lokalen Umgebung die Dokumentation für Ihre Quelle erstellen und eine Pull-Anfrage (PR) senden.
Voraussetzungen
Für das folgende Tutorial muss GitHub Desktop auf Ihrem lokalen Computer installiert sein. Wenn Sie keinen GitHub-Desktop haben, können Sie die Anwendung ().
Verbinden mit GitHub und Einrichten der lokalen Authoring-Umgebung
Der erste Schritt beim Einrichten Ihrer lokalen Authoring-Umgebung besteht darin, zum Adobe Experience Platform GitHub-Repository zu.
Wählen Sie auf der Hauptseite des Platform-GitHub-Repositorys die Option Verzweigung aus.
Um das Repository auf Ihren lokalen Computer zu klonen, wählen Sie Code aus. Wählen Sie aus dem angezeigten Dropdown-Menü HTTPS und klicken Sie dann auf Mit GitHub Desktop öffnen.
Warten Sie als Nächstes einige Augenblicke, bis GitHub Desktop das experience-platform.en-Repository geklont hat.
Sobald der Klonvorgang abgeschlossen ist, gehen Sie zu GitHub Desktop , um eine neue Verzweigung zu erstellen. Wählen Sie oberen Navigationsbereich die Option Master“ und dann Neue Verzweigung
Geben Sie im angezeigten Popup-Fenster einen beschreibenden Namen für Ihre Verzweigung ein und wählen Sie dann Verzweigung erstellen aus.
Wählen Sie als Nächstes Publish-Verzweigung.
Erstellen der Dokumentationsseite für Ihre Quelle
Nachdem das Repository auf den lokalen Computer geklont und eine neue Verzweigung erstellt wurde, können Sie jetzt mit dem Erstellen 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 im linken Navigationsbereich Registerkarte Erweiterungen“ aus.
Geben Sie als Nächstes Adobe Markdown Authoring in die Suchleiste ein und wählen Sie dann auf der Seite die Option Installieren“ aus.
Wenn Ihr lokaler Computer bereit ist, laden Sie die Quelldokumentationsvorlage herunter und extrahieren Sie die Datei, um mit [...] zu experience-platform.en/help/sources/tutorials/api/create/..., die die Kategorie Ihrer Wahl darstellt. Wenn Sie beispielsweise eine Datenbankquelle erstellen, wählen Sie den Datenbankordner aus.
Befolgen Sie abschließend die auf der Vorlage beschriebenen Anweisungen und bearbeiten Sie die Vorlage mit den relevanten Informationen zu Ihrer Quelle.
Reichen Sie Ihre Dokumentation zur Überprüfung ein
Um eine Pull-Anfrage (PR) zu erstellen und Ihre Dokumentation zur Überprüfung zu senden, speichern Sie zunächst Ihre Arbeit in Visual Studio Code (oder in Ihrem ausgewählten Texteditor). Geben Sie als Nächstes mithilfe von GitHub Desktop eine Commit-Nachricht ein und wählen Sie Commit an create-source-documentation.
Wählen Sie als Nächstes Push-Herkunft aus, um Ihre Arbeit in die Remote-Verzweigung hochzuladen.
Um eine Pull-Anfrage zu erstellen, wählen Sie Pull-Anfrage erstellen aus.
Stellen Sie sicher, dass die Basis- und Vergleichsverzweigungen korrekt sind. Fügen Sie der PR einen Hinweis hinzu, der Ihre Aktualisierung beschreibt, und wählen Sie dann Pull-Anfrage erstellen aus. Dadurch wird ein PR geöffnet, in dem der Arbeitszweig Ihrer Arbeit mit dem Hauptzweig des Adobe-Repositorys zusammengeführt wird.
Sie können bestätigen, dass die Pull-Anforderung gesendet wurde, indem Sie die Registerkarte Pull-Anforderungen in https://github.com/AdobeDocs/experience-platform.en überprüfen.
