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 angegebenen Schritte durchführen, lesen Sie Ihr Ziel in Adobe Experience Platform-Zielen dokumentieren.
Stellen Sie eine Verbindung zu GitHub her und richten Sie Ihre lokale Authoring-Umgebung ein. set-up-environment
-
Navigieren Sie in Ihrem Browser zu
https://github.com/AdobeDocs/experience-platform.en. -
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.
-
Klonen Sie das Repository auf Ihrem lokalen Computer. Wählen Sie "Code > HTTPS > Öffnen mit GitHub Desktop", wie unten dargestellt. Stellen Sie sicher, dass GitHub Desktop installiert ist. Weitere Informationen finden Sie unter Lokalen Klon des Repositorys erstellen im Adobe-Contributor-Handbuch.
-
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 zu Experience Platform hinzufügen, wählen Sie den Ordnerpersonalizationaus.
Dokumentationsseite für Ihr Ziel erstellen author-documentation
- Ihre Dokumentationsseite basiert auf der Self-Service-Zielvorlage. Laden Sie die Zielvorlage herunter. Entpacken Sie sie und extrahieren Sie die Datei "
yourdestination-template.md" in das Verzeichnis, das oben in Schritt 4 erwähnt wurde. Benennen Sie die Datei "YOURDESTINATION.md"um, wobei YOURDESTINATION der Name Ihres Ziels in Adobe Experience Platform ist. Wenn Ihr Unternehmen beispielsweise Moviestar heißt, würden Sie Ihre Dateimoviestar.mdnennen. - Öffnen Sie die neue Datei in Ihrem gewünschten Texteditor. 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 Bildschirmseite 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.
- Navigieren Sie für Screenshots oder Bilder, die Sie Ihrer Dokumentation hinzufügen möchten, zu
GitHub/experience-platform.en/help/destinations/assets/catalog/[...], wobei[...]die gewünschte Kategorie für Ihr Ziel ist. Wenn Sie beispielsweise ein Personalisierungsziel zu Experience Platform hinzufügen, wählen Sie den Ordnerpersonalizationaus. 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. - Wenn Sie bereit sind, speichern Sie die Datei, an der Sie arbeiten.
Übermitteln der Dokumentation zur Überprüfung submit-review
- Erstellen Sie in GitHub Desktop eine Arbeitsverzweigung für Ihre Aktualisierungen und wählen Sie Publish-Verzweigung aus, um die Verzweigung auf GitHub zu veröffentlichen.
-
In GitHub Desktop commit Ihre Arbeit, wie unten dargestellt.
-
Im GitHub-Desktop wird Ihre Arbeit durch Push an den Zweig remote übertragen, wie unten dargestellt.
-
Ö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 die Verzweigung, an der Sie gearbeitet haben, ausgewählt ist, und wählen Sie Contribute > Pull-Anforderung öffnen.
-
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. 
-
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.
-
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.
- 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.