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).

CONSEIL

Vous pouvez utiliser les documents suivants du guide de contribution d’Adobe pour mieux prendre en charge votre processus de documentation :

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.

platform-repo

Ensuite, sélectionnez Branchement.

double

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 à votre branche, car il sera utilisé pour contenir votre travail, puis sélectionnez créer une branche.

create-branch

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.

CONSEIL

Si vous créez une documentation pour l’interface utilisateur, accédez à experience-platform.en/help/sources/tutorials/ui/create/ et sélectionnez la catégorie appropriée à votre source. Pour ajouter vos images, accédez à experience-platform.en/help/sources/images/tutorials/create/sdk ajoutez ensuite vos captures d’écran à la sdk dossier.

crm

Un dossier de sources CRM existantes s’affiche. Pour ajouter la documentation d’une nouvelle source, sélectionnez Ajouter un fichier puis sélectionnez Créer un fichier dans le menu déroulant qui s’affiche.

create-new-file

Nommez votre fichier source. YOURSOURCE.md où YOURSOURCE est le nom de votre source dans Platform. Par exemple, si votre société est CRM ACME, votre nom de fichier doit être : acme-crm.md.

git-interface

Créez la page de documentation de votre source.

Pour commencer à documenter votre nouvelle source, collez le contenu de la modèle de documentation sources dans l’éditeur web GitHub. Vous pouvez également télécharger le modèle. here.

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.

paste-template

Une fois terminé, validez le fichier dans votre branche.

commit

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 Comparaison et extraction de requête.

compare-pr

Assurez-vous que les branches de base et de comparaison sont correctes. Ajoutez une note au communiqué, décrivant votre mise à jour, puis sélectionnez Créer une requête d’extraction. 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.

CONSEIL

Laissez le champ Autorisation des modifications par les responsables case à cocher sélectionnée pour vous assurer que l’équipe de documentation d’Adobe peut apporter des modifications au résiduel.

create-pr

À 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.

confirm-pr

Sur cette page