Verwenden eines Texteditors in der lokalen Umgebung, um eine Zieldokumentationsseite zu erstellen local-authoring

Die Anweisungen auf dieser Seite zeigen Ihnen, wie Sie einen Texteditor verwenden, um in Ihrer lokalen Umgebung zu arbeiten, um Dokumentation zu erstellen und eine Pull-Anfrage (PR) zu senden. Bevor Sie die hier angegebenen Schritte durchlaufen, lesen Sie Dokumentieren Ihres Ziels in Adobe Experience Platform-Zielen.

TIP
Weitere Informationen finden Sie in der unterstützenden Dokumentation im Adobe-Handbuch für Mitwirkende:

Verbinden mit GitHub und Einrichten der lokalen Authoring-Umgebung set-up-environment

  1. Navigieren Sie im Browser zu https://github.com/AdobeDocs/experience-platform.en

  2. Um Verzweigung das Repository anzuzeigen, klicken Sie auf Verzweigung wie unten dargestellt. Dadurch wird eine Kopie des Experience Platform-Repositorys in Ihrem eigenen GitHub-Konto erstellt.

    Dokumentations-Repository für Verzweigung Adobe

  3. Klonen Sie das Repository auf Ihrem lokalen Computer. Wählen Sie Code > HTTPS > Mit GitHub Desktop öffnen aus, wie unten dargestellt. Stellen Sie sicher, dass GitHub Desktop installiert ist. Weitere Informationen finden Sie unter Erstellen eines lokalen Klons des Repositorys im Handbuch für Mitwirkende an Adobe.

    Klonen des Dokumentations-Repositorys für Adobe in die lokale Umgebung

  4. Navigieren Sie in Ihrer lokalen Dateistruktur zu experience-platform.en/help/destinations/catalog/[...] , wobei [...] die gewünschte Kategorie für Ihr Ziel ist. Wenn Sie beispielsweise ein Personalisierungsziel zum Experience Platform hinzufügen, wählen Sie den personalization aus.

Erstellen der Dokumentationsseite für Ihr Ziel author-documentation

  1. Ihre Dokumentationsseite basiert auf der Self-Service-Zielvorlage. Laden Sie die Zielvorlage“. Entpacken Sie sie und extrahieren Sie die Datei yourdestination-template.md in das in Schritt 4 oben erwähnte Verzeichnis. Benennen Sie die Datei YOURDESTINATION.md um, wobei YOURDESTINATION der Name Ihres Ziels in Adobe Experience Platform ist. Wenn Ihre Firma beispielsweise Moviestar heißt, würden Sie Ihre Datei moviestar.md nennen.
  2. Öffnen Sie die neue Datei in Ihrem Texteditor Ihrer Wahl. Adobe empfiehlt die Verwendung von Visual Studio Code und die Installation der Adobe Markdown Authoring-Erweiterung. Um die Erweiterung zu installieren, öffnen Sie Visual Studio Code, wählen Sie die Registerkarte Extensions auf der linken Seite des Bildschirms aus und suchen Sie nach adobe markdown authoring. Wählen Sie die Erweiterung aus und klicken Sie auf Install.
    Installieren der Adobe Markdown Authoring-Erweiterung
  3. Bearbeiten Sie die Vorlage mit relevanten Informationen für Ihr Ziel. Befolgen Sie die Anweisungen in der Vorlage.
  4. Screenshots oder Bilder, die Sie Ihrer Dokumentation hinzufügen möchten, finden Sie unter GitHub/experience-platform.en/help/destinations/assets/catalog/[...] , wobei [...] die gewünschte Kategorie für Ihr Ziel ist. Wenn Sie beispielsweise ein Personalisierungsziel zum Experience Platform hinzufügen, wählen Sie den personalization aus. Erstellen Sie einen neuen Ordner für Ihr Ziel und speichern Sie Ihre Bilder hier. Sie müssen von der Seite, die Sie erstellen, aus eine Verknüpfung zu ihnen herstellen. Siehe Anweisungen zum Verknüpfen mit Bildern.
  5. Wenn Sie fertig sind, speichern Sie die Datei, an der Sie arbeiten.

Reichen Sie Ihre Dokumentation zur Überprüfung ein submit-review

TIP
Beachten Sie, dass es hier nichts gibt, was Sie brechen können. Wenn Sie die Anweisungen in diesem Abschnitt befolgen, schlagen Sie einfach eine Aktualisierung der Dokumentation vor. Die vorgeschlagene Aktualisierung wird vom Dokumentations-Team von Adobe Experience Platform genehmigt oder bearbeitet.
  1. Erstellen Sie in GitHub Desktop eine Arbeitsverzweigung für Ihre Updates und wählen Sie Publish-Verzweigung, um die Verzweigung auf GitHub zu veröffentlichen.

Neue lokale Verzweigung

  1. Führen Sie in GitHub Desktop Commit Ihre Arbeit aus, wie unten dargestellt.

    Commit lokal

  2. Wählen Sie in GitHub Desktop Push Ihre Arbeit in die remote-Verzweigung aus, wie unten dargestellt.

    Pushen Sie Ihren Commit

  3. Öffnen Sie in der GitHub-Web-Benutzeroberfläche eine Pull Request (PR), um Ihre Arbeitsverzweigung mit der Hauptverzweigung des Adobe-Dokumentations-Repositorys zusammenzuführen. Stellen Sie sicher, dass die Verzweigung, an der Sie gearbeitet haben, ausgewählt ist, und wählen Sie Contribute > Pull-Anfrage öffnen.

    Pull-Anfrage erstellen

  4. 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 Pull-Anfrage erstellen. Dadurch wird ein PR geöffnet, in dem der Arbeitszweig Ihres Abspaltungs mit dem Hauptzweig des Adobe-Repositorys zusammengeführt wird.

    note tip
    TIP
    Lassen Sie das Bearbeitung durch Betreuer zulassen aktiviert, damit das Dokumentations-Team von Adobe Änderungen am PR vornehmen kann.

    Erstellen einer Pull-Anfrage an das Adobe-Dokumentations-Repository

  5. An dieser Stelle wird eine Benachrichtigung angezeigt, die Sie auffordert, die Adobe Contributor License Agreement (CLA) zu unterzeichnen. Dies ist ein obligatorischer Schritt. Nachdem Sie die CLA signiert haben, aktualisieren Sie die PR-Seite und senden Sie die Pull-Anfrage.

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

PR erfolgreich

  1. Vielen Dank! Das Adobe-Dokumentations-Team wird sich an den PR wenden, falls Änderungen erforderlich sind, und Ihnen mitteilen, wann die Dokumentation veröffentlicht wird.
TIP
Um Bilder und Links zu Ihrer Dokumentation und zu anderen Fragen rund um Markdown hinzuzufügen, lesen Sie Verwenden von Markdown im Handbuch zum gemeinsamen Schreiben von Adobe.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6