Quelle dokumentieren
Der letzte Schritt, bevor Ihre neue Quelle in Adobe Experience Platform live gesetzt werden kann, besteht darin, Ihre neue Quelle zu dokumentieren.
Dieses Dokumentationshandbuch enthält:
- Ein Tutorial, dem Sie folgen können, um eine Dokumentationsseite für Ihre neue Quelle zu erstellen.
- eine Dokumentationsvorlage, die Sie für Ihre neue Quelle ausfüllen können;
- Anweisungen zur Verwendung von Markdown zum Schreiben technischer Dokumentation;
- Anleitung zum Verständnis von Adobe Markdown-Geschmack.
Voraussetzungen
Die folgenden Elemente sind erforderlich, bevor Sie mit der Dokumentation Ihrer neuen Quelle beginnen können:
- Ein gültiges GitHub-Benutzerkonto: Wenn Sie kein GitHub-Konto haben, müssen Sie eines über das GitHub-Anmeldeseite;
- Zugriff auf GitHub Desktop: Sie müssen die GitHub Desktop App um die Quelldokumentation in Ihrer lokalen Umgebung zu erstellen;
- Ihre Integration mit Adobe muss sich in einer Testphase befinden, während Ihre Quelle in einer Staging-Umgebung in Platform bereitgestellt wird.
Allgemeine Anweisungen zum Erstellen der Dokumentation für Ihre Quelle in Platform
Um eine Dokumentation für Ihre Quelle zu erstellen, müssen Sie auf hoher Ebene eine Abspaltung des Platform-Dokumentations-Repositorys erstellen und die bereitgestellte Dokumentationsvorlage in einer neuen Verzweigung bearbeiten. Verwenden Sie die vom Adobe bereitgestellte Vorlage, um eine neue Quellseite zu erstellen und eine Pull-Anforderung (PA) zu öffnen, sobald Sie bereit sind. Anweisungen dazu finden Sie weiter unten in den Schritten zum Erstellen Ihrer neuen Quellseite.
Dokumentationsvorlage
Sie können eine Dokumentationsvorlage , um die Erstellung der Dokumentation für Ihre Quelle zu unterstützen. Weiter unten finden Sie Anweisungen zum Bearbeiten der Vorlage und Öffnen einer Pull-Anforderung. Die eingesendete Dokumentation für Ihre neue Quelle wird vom Adobe-Dokumentationsteam geprüft und veröffentlicht.
Sie können auch die folgenden Dokumentationsvorlagen herunterladen:
Neue Quellseite erstellen
Sie können die GitHub-Webschnittstelle oder Ihre lokale Umgebung verwenden, um eine Dokumentation für Ihre neue Quelle in Platform zu erstellen. Anweisungen für beide Optionen finden Sie unter den folgenden Links: