DokumentationExperience PlatformZielhandbuch

Verwenden der GitHub-Web-Oberfläche, um eine Zieldokumentationsseite zu erstellen github-interface

Last update: Tue Dec 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • Benutzende

Die folgenden Anweisungen zeigen Ihnen, wie Sie die GitHub-Web-Oberfläche verwenden, um Dokumentationen 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:

Einrichten der GitHub-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. Erstellen Sie in Ihrem Abspaltungs-Repository eine neue Verzweigung für Ihr Projekt, wie unten dargestellt. Verwenden Sie diese neue Verzweigung für Ihre Arbeit.

    Neue GitHub-Verzweigung erstellen

  4. Navigieren Sie in der GitHub-Ordnerstruktur des abgespalteten Repositorys 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 die Kategorie personalization aus. Wählen Sie Datei hinzufügen > Neue Datei erstellen.

    Neue Datei hinzufügen

  5. Benennen Sie Ihr YOURDESTINATION.md, 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.

Erstellen der Dokumentationsseite für Ihr Ziel author-documentation

  1. Sie erstellen den Inhalt Ihrer Zielseite basierend auf der Dokumentations-Self-Service-Vorlage. Laden Sie Vorlage herunter und entpacken Sie sie, um die .md Dateivorlage zu extrahieren.

  2. Fügen Sie den Inhalt der Vorlage ein und bearbeiten Sie ihn mit relevanten Informationen für Ihr Ziel in einem Online-Markdown-Editor, z. B. dillinger.io. Folgen Sie den Anweisungen in der Vorlage, um zu erfahren, was Sie ausfüllen sollten und welche Absätze entfernt werden können.

    note tip
    TIP
    Sie können Ihr Browser-Fenster jederzeit schließen und später erneut öffnen. Ihre Arbeit wird automatisch gespeichert und wartet auf Sie, wenn Sie den Browser erneut öffnen.

    3. Kopieren Sie den Inhalt aus dem Markdown-Editor in Ihre neue Datei in GitHub.

  3. Verwenden Sie für alle Screenshots oder Bilder, die Sie verwenden möchten, die GitHub-Oberfläche, um die Dateien in experience-platform.en/help/destinations/assets/catalog/[...] hochzuladen, wobei [...] die gewünschte Kategorie für Ihr Ziel ist. Wenn Sie beispielsweise ein Personalisierungsziel zum Experience Platform hinzufügen, wählen Sie die Kategorie personalization aus. Sie müssen eine Verknüpfung zu den Bildern auf der Seite herstellen, die Sie gerade bearbeiten. Siehe Anweisungen zum Verknüpfen mit Bildern.

    Bild auf GitHub hochladen

  4. Wenn Sie fertig sind, speichern Sie die Datei in Ihrer Verzweigung.

Bestätigen der Dateierstellung

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. Nachdem Sie die Datei gespeichert und die gewünschten Bilder hochgeladen haben, können Sie eine Pull-Anfrage (PR) öffnen, 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

  1. 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

  2. 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.

  3. 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

  4. 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