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.
Verbinden mit GitHub und Einrichten der lokalen Authoring-Umgebung set-up-environment
-
Navigieren Sie im Browser zu
https://github.com/AdobeDocs/experience-platform.en -
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.
-
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.
-
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 denpersonalizationaus.
Erstellen der Dokumentationsseite für Ihr Ziel author-documentation
- Ihre Dokumentationsseite basiert auf der Self-Service-Zielvorlage. Laden Sie die Zielvorlage“. Entpacken Sie sie und extrahieren Sie die Datei
yourdestination-template.mdin das in Schritt 4 oben erwähnte Verzeichnis. Benennen Sie die DateiYOURDESTINATION.mdum, wobei YOURDESTINATION der Name Ihres Ziels in Adobe Experience Platform ist. Wenn Ihre Firma beispielsweise Moviestar heißt, würden Sie Ihre Dateimoviestar.mdnennen. - Ö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.
- Bearbeiten Sie die Vorlage mit relevanten Informationen für Ihr Ziel. Befolgen Sie die Anweisungen in der Vorlage.
- 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 denpersonalizationaus. 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. - Wenn Sie fertig sind, speichern Sie die Datei, an der Sie arbeiten.
Reichen Sie Ihre Dokumentation zur Überprüfung ein submit-review
- 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.
-
Führen Sie in GitHub Desktop Commit Ihre Arbeit aus, wie unten dargestellt.
-
Wählen Sie in GitHub Desktop Push Ihre Arbeit in die remote-Verzweigung aus, wie unten dargestellt.
-
Ö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.
-
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. 
-
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.
-
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.
- 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.