GitHub
Tous les workflows commencent et se terminent au niveau de GitHub, où est stocké le référentiel principal de tout projet de documentation Adobe. Les copies que les contributeurs créent pour leur propre utilisation sont réparties entre plusieurs ordinateurs. Ces copies sont finalement réconciliées dans le référentiel GitHub principal du projet.
Organisation du répertoire
La branche par défaut/principale d’un projet sert de version actuelle du contenu destiné au projet. Le contenu dans la branche principale (et dans les embranchements créés à partir de cette dernière) s’aligne sur l’organisation des rubriques de l’article. Les sous-répertoires servent à organiser le contenu et les actifs d’image.
Vous pouvez généralement trouver un répertoire help
principal sur la racine du référentiel. Le répertoire d’articles contient un ensemble de sous-répertoires. Les articles dans les sous-répertoires sont formatés sous la forme de fichiers Markdown, qui utilisent une extension .md.
Dans la racine de ce répertoire, vous trouvez des articles généraux relatifs au produit ou au service global. En général, vous pouvez ensuite trouver d’autres séries de sous-répertoires qui correspondent aux fonctionnalités/services ou aux scénarios communs.
Répertoire d’actifs
Les répertoires du guide de l’utilisateur contiennent des sous-répertoires /assets
pour les fichiers image référencés dans un répertoire.
Requêtes de tirage
Une requête de tirage permet à un contributeur de proposer facilement un ensemble de modifications à appliquer à la branche par défaut. Les modifications (également appelées validations) sont stockées dans la branche d’un contributeur, de sorte que GitHub puisse tout d’abord modéliser l’impact de leur fusion dans la branche par défaut. Une requête de tirage sert également de mécanisme permettent au contributeur de recevoir des commentaires d’un processus de création/validation, le réviseur de requête de tirage, afin de résoudre les problèmes ou questions potentiels avant que les modifications ne soient fusionnées dans la branche par défaut.
Il existe deux manières de contribuer à l’aide d’une requête de tirage, selon la taille des modifications que vous souhaitez proposer. Nous aborderons ce point en détail ultérieurement, dans la section GitHub workflow de ce guide.