Dokumentieren der Quelle
Erstellt für:
- Entwickler
Der letzte Schritt, bevor Ihre neue Quelle in Adobe Experience Platform live geschaltet werden kann, besteht darin, Ihre neue Quelle zu dokumentieren.
Dieses Dokumentationshandbuch umfasst:
- 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 Dokumentationen;
- Anweisungen zum Verstehen der Adobe-Markdown-Variante.
Voraussetzungen
Die folgenden Elemente sind erforderlich, bevor Sie mit der Dokumentation Ihrer neuen Quelle beginnen können:
- Ein gültiges GitHub-Benutzerkonto: Wenn Sie noch kein GitHub-Konto haben, müssen Sie eines über die GitHub-Anmeldeseite erstellen;
- Zugriff auf GitHub Desktop: Sie müssen die GitHub Desktop App verwenden, um Ihre Quelldokumentation in Ihrer lokalen Umgebung zu erstellen;
- Ihre Integration mit Adobe muss sich in einer Testphase befinden und Ihre Quelle muss in einer Staging-Umgebung in Experience Platform bereitgestellt werden.
Allgemeine Anweisungen zum Erstellen der Dokumentation für Ihre Quelle in Experience Platform
Um eine Dokumentation für Ihre Quelle zu erstellen, müssen Sie eine Abspaltung des Experience Platform-Dokumentations-Repositorys erstellen und die bereitgestellte Dokumentationsvorlage in einer neuen Verzweigung bearbeiten. Verwenden Sie die von Adobe bereitgestellte Vorlage, um eine neue Quellseite zu erstellen und eine Pull-Anfrage (PR) zu öffnen, wenn Sie bereit sind. Anweisungen dazu finden Sie weiter unten, in Schritten zum Erstellen Ihrer neuen Quellseite.
Dokumentationsvorlage
Sie können eine vorausgefüllte (Dokumentationsvorlage verwenden,beim Erstellen der Dokumentation für Ihre Quelle zu helfen. Weiter unten finden Sie Anweisungen zum Bearbeiten der Vorlage und zum Öffnen einer Pull-Anfrage. Die eingereichte Dokumentation für Ihre neue Quelle wird vom Adobe-Dokumentations-Team geprüft und veröffentlicht.
Sie können auch die folgenden Dokumentationsvorlagen herunterladen:
Neue Quellseite erstellen
Sie können die GitHub-Web-Oberfläche oder Ihre lokale Umgebung verwenden, um Dokumentation für Ihre neue Quelle in Experience Platform zu erstellen. Anweisungen für beide Optionen finden Sie in den folgenden Links: