Documenter votre source
Créé pour :
- Développeur
La dernière étape avant que votre nouvelle source puisse être mise en ligne dans Adobe Experience Platform consiste à documenter votre nouvelle source.
Ce guide de documentation comprend :
- Tutoriel que vous pouvez suivre pour créer une page de documentation pour votre nouvelle source ;
- Un modèle de documentation à remplir pour votre nouvelle source ;
- Instructions sur la façon d’utiliser Markdown pour rédiger la documentation technique
- Instructions pour comprendre la version Adobe Markdown.
Conditions préalables
Les éléments suivants sont requis avant de commencer à documenter votre nouvelle source :
- Un compte utilisateur GitHub valide : si vous ne disposez pas d’un compte GitHub existant, vous devez en créer un via la page d’inscription GitHub ;
- Accès à GitHub Desktop : vous devez utiliser l’application GitHub Desktop afin de créer votre documentation source dans votre environnement local ;
- Votre intégration à Adobe doit être en phase de test, avec votre source déployée dans un environnement d’évaluation dans Experience Platform.
Instructions générales pour créer de la documentation pour votre source dans Experience Platform
À un niveau élevé, pour créer de la documentation pour votre source, vous devez créer un formulaire du référentiel de documentation Experience Platform et modifier le modèle de documentation fourni dans une nouvelle branche. Utilisez le modèle fourni par Adobe pour créer une page source et ouvrir une requête de tirage (PR) lorsque vous êtes prêt(e). Pour ce faire, reportez-vous aux instructions ci-dessous, dans la procédure de création de votre page source.
Modèle de documentation
Vous pouvez utiliser un modèle de documentation prérempli pour vous aider à créer de la documentation pour votre source. Plus bas, vous trouverez des instructions sur la modification du modèle et l’ouverture d’une requête d’extraction. La documentation envoyée pour votre nouvelle source sera examinée et publiée par l’équipe de documentation d’Adobe.
Vous pouvez également télécharger les modèles de documentation ci-dessous :
Créer votre page source
Vous pouvez utiliser l’interface web GitHub ou votre environnement local pour créer la documentation de votre nouvelle source dans Experience Platform. Recherchez des instructions pour les deux options dans les liens ci-dessous :