Utiliser un éditeur de texte dans votre environnement local pour créer une page de documentation sur les sources
Ce document décrit les étapes à suivre pour utiliser votre environnement local afin de créer de la documentation pour votre source et d’envoyer une requête de tirage (PR).
Conditions préalables
Le tutoriel suivant nécessite que GitHub Desktop soit installé sur votre ordinateur local. Si vous ne disposez pas de l’appli de bureau GitHub, vous pouvez télécharger l’application ici.
Connexion à GitHub et configuration de votre environnement de création local
La première étape de la configuration de votre environnement de création local consiste à accéder au référentiel Adobe Experience Platform GitHub.
Sur la page principale du référentiel Platform GitHub, sélectionnez Fork.
Pour cloner le référentiel sur votre ordinateur local, sélectionnez Code. Dans le menu déroulant qui s’affiche, sélectionnez HTTPS, puis Ouvrir avec GitHub Desktop.
Ensuite, laissez quelques instants au bureau GitHub pour cloner le référentiel experience-platform.en.
Une fois le processus de clonage terminé, accédez à GitHub Desktop pour créer une nouvelle branche. Sélectionnez Principal dans le volet de navigation supérieur, puis Nouvelle branche
Dans le panneau contextuel qui s’affiche, saisissez un nom descriptif pour votre branche, puis sélectionnez Créer une branche.
Sélectionnez ensuite branche Publish.
Créez la page de documentation de votre source.
Une fois le référentiel cloné sur votre ordinateur local et une nouvelle branche créée, vous pouvez commencer à créer la page de documentation de votre nouvelle source par le biais de l’ éditeur de texte de votre choix.
Adobe vous recommande d’utiliser Visual Studio Code et d’installer l’extension de création Adobe Markdown. Pour installer l’extension, lancez Visual Studio Code, puis sélectionnez l’onglet Extensions dans le volet de navigation de gauche.
Ensuite, saisissez Adobe Markdown Authoring dans la barre de recherche, puis sélectionnez Installer dans la page qui s’affiche.
Lorsque votre ordinateur local est prêt, téléchargez le modèle de documentation des sources et extrayez le fichier vers experience-platform.en/help/sources/tutorials/api/create/... avec [...] représentant la catégorie de votre choix. Par exemple, si vous créez une source de base de données, sélectionnez le dossier de base de données.
Enfin, suivez les instructions décrites dans le modèle et modifiez-le avec les informations pertinentes concernant votre source.
Soumettre votre documentation pour révision
Pour créer une requête de tirage (PR) et envoyer votre documentation pour révision, enregistrez d’abord votre travail dans Visual Studio Code (ou dans l’éditeur de texte de votre choix). Ensuite, à l’aide de GitHub Desktop, saisissez un message de validation et sélectionnez Commit to create-source-documentation.
Sélectionnez ensuite Push origin pour charger votre travail dans la branche distante.
Pour créer une requête de tirage, sélectionnez Créer une requête de tirage.
Assurez-vous que les branches de base et de comparaison sont correctes. Ajoutez une note au document de présentation, décrivant votre mise à jour, puis sélectionnez Créer une requête de tirage. Cela ouvre une requête de tirage pour fusionner la branche opérationnelle de votre travail dans la branche principale du référentiel Adobe.
Vous pouvez confirmer que la demande d’extraction a été envoyée en consultant l’onglet des demandes d’extraction dans https://github.com/AdobeDocs/experience-platform.en.
