Contribution via l'interface GitHub (en ligne)
Cette méthode est la plus simple. Elle ne nécessite aucune installation et convient pour des corrections ponctuelles (fautes, liens brisés, reformulations courtes).
Avant de commencer, assurez-vous d'avoir un compte GitHub et un accès au dépôt aps-docs. Consultez la page Prérequis si ce n'est pas encore fait.
Accéder au dépôt
Depuis le site de documentation docs.avanteam.fr, cliquez sur le bouton GitHub en haut à droite de la page pour accéder directement au dépôt.
Le bouton GitHub est visible dans la barre de navigation en haut à droite :
Étapes
1. Naviguez jusqu'au fichier
Naviguez jusqu'au fichier Markdown que vous souhaitez modifier. Les fichiers de documentation sont organisés dans deux dossiers principaux :
docs-internal— documentation interne
docs-public— documentation publique
2. Ouvrez l'éditeur en ligne
Cliquez sur l'icône crayon (« Edit this file ») visible dans la barre d'actions en haut à droite du fichier.
3. Effectuez vos modifications
Modifiez directement le contenu dans l'éditeur en ligne.
4. Proposez vos modifications
Cliquez sur le bouton Commit changes en haut à droite de l'éditeur. Une fenêtre s'ouvre : sélectionnez l'option Create a new branch for this commit and start a pull request, renseignez un message de commit clair (ex. : Correction du titre tronqué dans le guide de paramétrage), puis cliquez sur Propose changes.
5. Créez la Pull Request
Sur la page qui s'ouvre, vérifiez le récapitulatif de vos modifications, puis cliquez sur Create pull request.
Vos modifications ne seront intégrées à la documentation en ligne qu'après validation explicite de la Pull Request par un administrateur. Un workflow de déploiement se déclenche automatiquement à la suite de cette validation.