Le présent site internet est généré à partir d’un ensemble de fichiers Markdown, écrits dans Obsidian et disponibles sur un dépôt Gitlab. Selon votre niveau de connaissance de ces standards d’écriture et de partage en source ouverte, nous vous proposons trois méthodes, de la plus simple à la plus complexe, pour participer à l’écriture, la relecture, la correction et l’évolution des ressources ouvertes d’architectures.
1. Nous contacter par email
C’est la méthode la plus simple pour contribuer à l’évolution de la documentation. Vous pouvez nous contacter à l’adresse contact@ressources.archi.
Merci de bien préciser dans votre mail l’objet de la contribution (ajout de contenu, signalement de bug, suggestion de modification, etc), nous reviendrons vers vous dans les plus brefs délais.
2. Ouvrir un ticket pour suggérer une modification
Si vous souhaitez proposer une idée, signaler un bug ou suggérer une amélioration sans coder directement, vous pouvez également ouvrir un ticket (une ‘issue’, si votre interface est en anglais) sur Gitlab.
Cette méthode nécessite d’avoir un compte Gitlab. Il est possible d’en créer un gratuitement sur cette page.
Une fois connecté sur Gitlab, il convient de se rendre sur la page du dépôt Gitlab : https://gitlab.com/avnd26/ressources-docs.
Dans la barre de gauche, cliquer sur l’onglet Programmation > Tickets (ou en anglais Plan > Issues). Créer un nouveau ticket, avec titre et description pour décrire votre contribution. Il est possible d’ajouter des fichiers joints, des images, etc. Une fois rédigé, créez votre ticket en cliquant sur Créer ticket.
Nous serons alors notifiés, et examinerons votre demande dans les plus brefs délais.
3. Faire une Merge Request
Si vous maîtrisez Git, il est possible de créer une Merge Request en suivant les étapes suivantes :
3.1. Forker le dépôt
Créer une copie dans votre espace personnel GitLab.
- Se rendre sur la page du dépôt Gitlab : https://gitlab.com/avnd26/ressources-docs.
- Cliquer sur le bouton Fork (en haut à droite).
- Attendez que GitLab crée le fork dans votre espace personnel.
- Vous avez maintenant une version personnelle du projet.
3.2. Cloner votre fork en local
Une fois le fork créé, il convient de le cloner sur votre machine (veillez à bien entrer l’adresse de votre fork) :
git clone https://gitlab.com/[YOUR_USERNAME]/ressources-docs.git
cd ressources-docsAjouter le dépôt d’origine comme remote pour pouvoir synchroniser votre travail avec la dernière version :
git remote add upstream https://gitlab.com/avnd26/ressources-docs.git
git fetch upstream3.3. Créer une branche pour votre contribution
Créer une nouvelle branche pour votre contribution afin d’éviter de travailler directement sur main (il convient de choisir un nom de branche en lien avec la contribution proposée) :
git checkout -b ma-nouvelle-branche3.4. Faire vos modifications
Effectuer les modifications dans le code, puis ajouter et valider les changements :
git add .
git commit -m "Ajout de la contribution X ou Y"3.5. Pousser votre branche sur votre fork
Envoyer votre travail vers votre dépôt forké :
git push origin ma-nouvelle-branche3.6. Créer une Merge Request (MR)
- Aller sur votre dépôt GitLab ;
- Accéder à la section Merge Requests ;
- Cliquer sur New Merge Request ;
- Sélectionner votre branche comme source et le dépôt original comme destination ;
- Remplir la description en expliquant votre contribution ;
- Cliquer sur Submit Merge Request.
3.7. Suivre et répondre aux retours
Avant de merge votre branche, nous pouvons être amenés à vous poser des questions ou à demander des modifications, merci de les prendre en considération pour l’acceptation de la requête, en apportant les corrections demandées et en poussant ces modifications avec git push origin ma-nouvelle-branche.
Lorsque la Merge Request sera approuvée de notre part, elle sera fusionnée dans le projet principal.