Présentation du guide du contributeur pour la documentation Adobe

Présentation de la documentation collaborative

La documentation technique et le contenu relatif à l’activation d’Adobe Experience Cloud et d’autres produits Adobe Enterprise ont été transférés vers une nouvelle plateforme. Cette nouvelle plateforme est fondée sur des principes open source qui utilisent les solutions Github, Markdown et Adobe Experience Cloud.

Ce modèle open source améliore la qualité du contenu et la communication entre les clients, les équipes de documentation et les équipes produit. Sur chaque page, vous pouvez désormais évaluer l’utilité du contenu, les problèmes de journalisation, et même contribuer à des suggestions de contenu sous la forme de requêtes de tirage Git (PR). Les équipes de documentation Adobe surveillent quotidiennement les contributions et les problèmes et effectuent des mises à jour et des ajustements, le cas échéant.

Utilisation de la documentation collaborative

En tant qu’utilisateur de ce contenu, que vous soyez employé, partenaire, client ou même client potentiel, vous avez le choix de contribuer à cette documentation de plusieurs manières simples ;

  • évaluer l’utilité de la page
  • enregistrer un problème sur une page spécifique
  • et même envoyer une modification rapide, jusqu’à la création d’articles entiers, avec des ressources et des exemples de code

Ce guide décrit tout ce que vous devez savoir pour interagir avec ce jeu de contenu et y contribuer.

Apporter des modifications rapides aux documents existants

Apporter des modifications rapides est un bon moyen de corriger de petites erreurs et omissions dans des documents. Si un article affiche un bouton de modification comme illustré ci-dessous, vous pouvez effectuer une correction rapide par vous-même. Lorsque vous modifiez le document, vous envoyez une requête de tirage pour nous soumettre la correction/suggestion, que nous pouvons ensuite refuser, approuver et publier.

  1. Signez le contrat de licence du contributeur (CLA) si acceptable.

    Il suffit d’envoyer une seule fois un CLA Adobe.

  2. Cliquez sur l’icône Edit this page dans la colonne de droite pour accéder au fichier source Markdown sur GitHub.

    Modifier cette icône de page

  3. Cliquez sur l’icône représentant un crayon pour modifier l’article.

    REMARQUE

    Si l’icône en forme de crayon est grisée, vous devez vous connecter à votre compte GitHub ou créer un compte.

    Emplacement de l’icône en forme de crayon

  4. Apportez vos modifications dans l’éditeur Web. Vous pouvez cliquer sur l’onglet Preview changes pour vérifier la mise en forme de votre modification.

  5. Une fois que vous avez apporté vos modifications, faites défiler l’écran jusqu’au bas de la page. Saisissez un titre et une description pour votre requête de tirage, puis cliquez sur Propose file change, comme le montre la figure suivante :

    votre suggestion de modification

    REMARQUE

    Si vous recevez un message d’erreur de validation sur la signature d’un contrat de licence du contributeur (CLA), cliquez sur Détails pour ouvrir le contrat de licence. Signez l’accord, si acceptable. Fermez et ouvrez ensuite la demande de tirage, puis continuez.

C’est aussi simple que cela. Merci ! Les membres de l’équipe de documentation vont examiner et fusionner votre requête de tirage.

Consigner un problème

Une autre manière simple de nous informer d’un problème lié à un élément de contenu consiste à consigner un problème.

  1. Si vous constatez un problème lié à un élément de contenu, cliquez sur l’icône Log an Issue dans la colonne de droite.

    REMARQUE

    Vous devez vous connecter à votre compte GitHub ou créer un compte pour consigner un problème.

    En cliquant sur ce lien, vous pouvez consigner un ticket rapide chez nous, à l’aide de l’interface GitHub Issues.

  2. L’URL de la page contenant le problème va automatiquement s’afficher le champ de description. Renseignez le titre, rédigez une brève description du problème, puis cliquez sur Submit new issue.

L’envoi d’un problème avertit directement l’équipe de contenu de cette page qui pourra agir. Une fois le contenu mis à jour, nous vous informerons dans l’interface GitHub Issues. Ensuite, vous serez averti par courrier électronique une fois la mise à jour ou la fermeture effectuée.

Comprendre les autorisations GitHub

L’interface utilisateur de modification de GitHub s’adapte aux autorisations de votre référentiel. Les images précédentes sont exactes pour les contributeurs qui ne disposent pas d’autorisations d’écriture dans le référentiel cible. GitHub crée automatiquement un double du référentiel cible dans votre compte. Si vous disposez d’un accès en écriture au référentiel cible, GitHub crée une branche dans le référentiel cible.

Adobe utilise des requêtes de tirage pour toutes les modifications, même dans le cas de contributeurs disposant d’un accès en écriture. La plupart des référentiels disposent d’une protection pour la branche master, de sorte que les mises à jour doivent être soumises en tant que requêtes de tirage.

L’expérience d’édition intégrée au navigateur est préférable pour les modifications mineures ou occasionnelles. Si vous effectuez des contributions de grande ampleur ou utilisez des fonctionnalités Git avancées, nous vous recommandons de dupliquer le référentiel et de travailler localement.

Fournir des commentaires

Avec une solution aussi vaste que celle d’Adobe, la documentation est toujours une œuvre inachevée. Si vous détectez des erreurs, consignez un problème, si vous avez des suggestions sur le matériel, partagez-les avec nous. Indiquez les informations que vous recherchez. Dites-nous si vous ne trouvez pas ce dont vous avez besoin ou, si vous avez rencontré des difficultés pour mener à bien votre tâche, faites-nous savoir comment nous pouvons vous aider à assimiler nos solutions.

L’équipe en charge de la documentation collaborative et tous les auteurs et producteurs de contenu vous adressent leurs remerciements Adobe Experience Cloud.

Sur cette page