Utilisation de l’interface web GitHub pour créer une page de documentation source
Ce document décrit les étapes à suivre pour utiliser l’interface web GitHub afin de créer de la documentation et d’envoyer une requête de tirage (PR).
Configuration de votre environnement GitHub
La première étape de la configuration de votre environnement GitHub consiste à accéder au référentiel GitHub Adobe Experience Platform.
Sélectionnez ensuite Branchement.
Une fois le branchement terminé, sélectionnez master et saisissez le nom de votre nouvelle branche dans le menu déroulant qui s’affiche. Assurez-vous de fournir un nom explicite pour votre branche, car il sera utilisé pour contenir votre travail, puis sélectionnez créer une branche.
Dans la structure de dossiers GitHub de votre référentiel dupliqué, accédez à experience-platform.en/help/sources/tutorials/api/create/, puis sélectionnez la catégorie appropriée à votre source dans la liste. Par exemple, si vous créez de la documentation pour une nouvelle source de gestion de la relation client, sélectionnez crm.
experience-platform.en/help/sources/tutorials/ui/create/ et sélectionnez la catégorie appropriée pour votre source. Pour ajouter vos images, accédez à experience-platform.en/help/sources/images/tutorials/create/sdk, puis ajoutez vos captures d’écran au dossier sdk.
Un dossier de sources CRM existantes s’affiche. Pour ajouter la documentation d’une nouvelle source, sélectionnez Ajouter un fichier, puis Créer un fichier dans le menu déroulant qui s’affiche.
Nommez votre fichier source YOURSOURCE.md où YOURSOURCE est le nom de votre source dans Platform. Par exemple, si votre société est ACME CRM, votre nom de fichier doit être acme-crm.md.
Créez la page de documentation de votre source.
Pour commencer à documenter votre nouvelle source, collez le contenu du modèle de documentation de sources dans l’éditeur web GitHub. Vous pouvez également télécharger le modèle ici.
Une fois le modèle copié dans l’interface de l’éditeur web GitHub, suivez les instructions décrites dans le modèle et modifiez les valeurs contenant les informations pertinentes pour votre source.
Une fois terminé, validez le fichier dans votre branche.
Soumettre votre documentation pour révision
Une fois votre fichier validé, vous pouvez ouvrir une requête de tirage (PR) pour fusionner votre branche opérationnelle dans la branche principale du référentiel de documentation Adobe. Assurez-vous que la branche sur laquelle vous avez travaillé est sélectionnée, puis sélectionnez Comparer et extraire la requête.
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.
À ce stade, une notification s’affiche pour vous inviter à signer le contrat de licence du contributeur Adobe (CLA). Cette étape est obligatoire. Après avoir signé le contrat de licence du contributeur, actualisez la page de requête de tirage et envoyez la requête de tirage.
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.
