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 können, um in Ihrer lokalen Umgebung Dokumentation zu erstellen und eine Pull-Anforderung (PR) zu senden. Bevor Sie die hier aufgeführten Schritte durchführen, lesen Sie Dokumentieren Ihres Ziels in Adobe Experience Platform-Zielen.

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

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

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

  2. nach Abspaltung Klicken Sie im Repository auf Verzweigung wie unten dargestellt. Dadurch wird eine Kopie des Experience Platform-Repositorys in Ihrem eigenen GitHub-Konto erstellt.

    Adobe-Dokumentations-Repository für Verzweigungen

  3. Repository auf Ihren lokalen Computer klonen. Auswählen Code > HTTPS > Öffnen mit GitHub Desktop, wie unten dargestellt. Stellen Sie sicher, dass GitHub Desktop installiert. Weitere Informationen finden Sie unter Lokalen Klon des Repositorys erstellen im Adobe-Contributor-Handbuch.

    Adobe-Dokumentations-Repository in lokale Umgebung klonen

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

Dokumentationsseite für Ihr Ziel erstellen author-documentation

  1. Ihre Dokumentationsseite basiert auf der Self-Service-Zielvorlage. Laden Sie die Zielvorlage. Entpacken Sie es und extrahieren Sie die Datei yourdestination-template.md in den in Schritt 4 genannten Ordner. Datei umbenennen YOURDESTINATION.md, wobei YOURDESTINATION der Name Ihres Ziels in Adobe Experience Platform ist. Wenn Ihr Unternehmen beispielsweise Moviestar heißt, geben Sie Ihrer Datei einen Namen moviestar.md.
  2. Öffnen Sie die neue Datei in Ihrem Texteditor der Wahl. Adobe empfiehlt die Verwendung von Visual Studio-Code und installieren Sie die Adobe Markdown Authoring-Erweiterung. Um die Erweiterung zu installieren, öffnen Sie Visual Studio Code und wählen Sie die Extensions auf der linken Bildschirmseite 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 [...] ist die gewünschte Kategorie für Ihr Ziel. Wenn Sie beispielsweise ein Personalisierungsziel zu Experience Platform hinzufügen, wählen Sie die personalization Ordner. Erstellen Sie einen neuen Ordner für Ihr Ziel und speichern Sie Ihre Bilder hier. Sie müssen auf der Seite, die Sie erstellen, eine Verknüpfung zu ihnen herstellen. Siehe Anweisungen zum Verknüpfen von Bildern.
  5. Wenn Sie bereit sind, speichern Sie die Datei, an der Sie arbeiten.

Ü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. Erstellen Sie in GitHub Desktop eine Arbeitsverzweigung für Ihre Aktualisierungen und wählen Sie Veröffentlichungsverzweigung , um die Verzweigung in GitHub zu veröffentlichen.

Neuer lokaler Zweig

  1. In GitHub Desktop commit Ihre Arbeit, wie unten dargestellt.

    Lokal bestätigen

  2. In GitHub Desktop push Ihre Arbeit an remote -Verzweigung, wie unten dargestellt.

    Übertragen

  3. Öffnen Sie in der GitHub-Webschnittstelle eine Pull-Anfrage (PA), um Ihre Arbeitsverzweigung mit der Masterverzweigung des Adobe-Dokumentations-Repositorys zusammenzuführen. Vergewissern Sie sich, dass der Zweig, an dem Sie gearbeitet haben, ausgewählt ist, und wählen Sie Beitragen > Pull-Anforderung öffnen.

    Pull-Anforderung erstellen

  4. Stellen Sie sicher, dass die Basis- und Vergleichsverzweigungen korrekt sind. Fügen Sie einen Hinweis zur PR hinzu, beschreiben Sie Ihr Update und wählen Sie Pull-Anforderung erstellen. 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 die Zulassen von Änderungen durch Maintainer aktivieren, damit das Adobe-Dokumentationsteam die PR bearbeiten kann.

    Pull-Anforderung zum Adobe-Dokumentations-Repository erstellen

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

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

PR erfolgreich

  1. 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 Markdown verwenden In Adobe haben wir gemeinsam eine Anleitung zum Schreiben erhalten.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6