DokumentationExperience PlatformZielhandbuch

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

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • Benutzende

Die folgenden Anweisungen zeigen Ihnen, wie Sie mit der GitHub-Web-Oberfläche Dokumentation erstellen und eine Pull-Anforderung (PA) senden können. Bevor Sie die hier angegebenen Schritte durchführen, lesen Sie Ihr Ziel in Adobe Experience Platform-Zielen dokumentieren.

TIP
Weitere Informationen finden Sie in der unterstützenden Dokumentation im Adobe Contributor Guide:

GitHub-Authoring-Umgebung einrichten set-up-environment

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

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

    Fork-Adobe-Dokumentations-Repository

  3. Erstellen Sie in Ihrer Abspaltung des Repositorys 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 zu Experience Platform hinzufügen, wählen Sie die Kategorie personalization aus. Wählen Sie Datei hinzufügen > Neue Datei erstellen aus.

    Neue Datei hinzufügen

  5. Nennen Sie Ihr Ziel "YOURDESTINATION.md", wobei YOURDESTINATION der Name Ihres Ziels in Adobe Experience Platform ist. Wenn Ihr Unternehmen beispielsweise Moviestar heißt, würden Sie Ihre Datei moviestar.md nennen.

Dokumentationsseite für Ihr Ziel erstellen author-documentation

  1. Sie erstellen den Inhalt Ihrer Zielseite auf der Grundlage der Vorlage für die Dokumentations-Selbstbedienung. Laden Sie die Vorlage herunter und dekomprimieren Sie sie, um die .md -Dateivorlage zu extrahieren.

  2. Fügen Sie den Inhalt der Vorlage mit relevanten Informationen für Ihr Ziel in einen Online-Markdown-Editor ein, z. B. dillinger.io. Folgen Sie den Anweisungen in der Vorlage, um zu erfahren, was Sie ausfüllen 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 zu Experience Platform hinzufügen, wählen Sie die Kategorie personalization aus. Sie müssen eine Verknüpfung zu den Bildern der Seite herstellen, die Sie erstellen. Siehe Anweisungen zum Verknüpfen von Bildern.

    Bild auf GitHub hochladen

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

Dateierstellung bestätigen

Übermitteln der Dokumentation zur Überprüfung submit-review

TIP
Beachten Sie, dass hier nichts kaputt gemacht werden kann. Indem Sie den Anweisungen in diesem Abschnitt folgen, schlagen Sie einfach eine Aktualisierung der Dokumentation vor. Ihre vorgeschlagene Aktualisierung wird vom Dokumentationsteam 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-Anforderung (PA) öffnen, um Ihre Arbeitsverzweigung mit der Masterverzweigung 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-Anforderung öffnen aus.

Pull-Anforderung erstellen

  1. 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 Pull-Anforderung erstellen aus. Dadurch wird ein PR-Vorgang zum Zusammenführen der Arbeitsverzweigung Ihrer Verzweigung mit der Masterverzweigung des Adobe-Repositorys geöffnet.

    note tip
    TIP
    Lassen Sie das Kontrollkästchen Änderungen durch Betreuer zulassen aktiviert, damit das Adobe-Dokumentationsteam die PR bearbeiten kann.

    Pull-Anforderung zum Adobe-Dokumentations-Repository erstellen

  2. An dieser Stelle wird eine Benachrichtigung angezeigt, in der Sie aufgefordert werden, die Lizenzvereinbarung für Adobe Contributor License Agreement (CLA) zu unterzeichnen. Dies ist ein notwendiger Schritt. Nachdem Sie die CLA signiert haben, aktualisieren Sie die PR-Seite und senden Sie die Pull-Anforderung.

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

    PA erfolgreich

  4. Vielen Dank! Das Adobe-Dokumentationsteam wird sich in der PR für den Fall, dass Änderungen erforderlich sind, an Sie wenden und Ihnen mitteilen, wann die Dokumentation veröffentlicht wird.

TIP
Lesen Sie zum Hinzufügen von Bildern und Links zu Ihrer Dokumentation sowie zu allen anderen Fragen rund um Markdown den Abschnitt Verwenden vonin der kollaborativen Anleitung zum Schreiben in Adobe Markdown.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6