Skip to content
Snippets Groups Projects
Commit d40b7c71 authored by Armand Bahi's avatar Armand Bahi
Browse files

Ajout des fonctionnalités de fork/merge

parent bfc02952
No related branches found
No related tags found
No related merge requests found
Showing
with 77 additions and 15 deletions
developpement/images/documentation_clone_gitlab.png

14.3 KiB

developpement/images/documentation_fork_gitlab1.png

1.71 KiB

developpement/images/documentation_fork_gitlab1_1.png

1.78 KiB

developpement/images/documentation_fork_gitlab2.png

31.9 KiB

developpement/images/documentation_fork_gitlab3.png

18.1 KiB

developpement/images/documentation_merge_gitlab1.png

25.9 KiB

developpement/images/documentation_merge_gitlab2.png

40.7 KiB

developpement/images/documentation_merge_gitlab3.png

31.4 KiB

developpement/images/documentation_merge_gitlab4.png

3.95 KiB

developpement/images/documentation_merge_gitlab5.png

22.2 KiB

# Participer à la documentation Readthedocs # Participer à la documentation Readthedocs
Au sein des équipes de Veremes, il arrive souvent que la documentation d'un Au sein des équipes de Veremes, il arrive souvent que la documentation d'un
produit ou d'un service se fasse par l'intermédiaire de GitHub et Readthedocs. produit ou d'un service se fasse par l'intermédiaire de Git et Readthedocs.
Pour ce faire, il faut utiliser le format Pour ce faire, il faut utiliser le format
[Markdown](https://guides.github.com/features/mastering-markdown/) et écrire des [Markdown](https://guides.github.com/features/mastering-markdown/) et écrire des
fichiers qui seront publiés sur un dépôt GitHub ; ces derniers seront alors lus fichiers qui seront publiés sur un dépôt Git ; ces derniers seront alors lus
par Readthedocs, qui va publier la documentation au format sur le web HTML. par Readthedocs, qui va publier la documentation au format sur le web HTML.
## 1. Les outils ## 1. Les outils
### Git/GitHub ### Git
Pour commencer, il faudra au minimum installer [Git](https://git-scm.com/) et Pour commencer, il faudra au minimum installer [Git](https://git-scm.com/) et
créer un compte sur [GitHub](https://github.com/). Ce qu'il faut comprendre de créer un compte sur le [GitLab de Veremes](http://vm09.veremes.net). Ce qu'il faut comprendre de
ces deux logiciels, c'est que **Git** s'installe sur un poste et permet de ces deux logiciels, c'est que **Git** s'installe sur un poste et permet de
versionner des fichiers de manière à pouvoir voir quels ont été les derniers versionner des fichiers de manière à pouvoir voir quels ont été les derniers
changements, revenir en arrière et faire plein d'autres choses très changements, revenir en arrière et faire plein d'autres choses très
intéressantes ; quant à **GitHub**, c'est une plateforme web où on pourra intéressantes ; quant à **GitLab**, c'est une plateforme web où on pourra
visualiser et héberger tout ceci. visualiser et héberger tout ceci.
### Atom ### Atom
Il existe plusieurs logiciels permettant d'écrire au format Markdown ; en Il existe plusieurs logiciels permettant d'écrire au format Markdown ; en
revanche, je conseille grandement [Atom](https://atom.io/) car il a été revanche, je conseille grandement [Atom](https://atom.io/) car il a été
développé par les équipes de GitHub et qu'il permet une grande interaction avec développé par les équipes de GitHub et qu'il permet une grande interaction avec
Git/GitHub ; de plus, en utilisant la commande ctrl + maj + M, on peut rapidement Git ; de plus, en utilisant la commande ctrl + maj + M, on peut rapidement
visionner ce que l'on écrit. visionner ce que l'on écrit.
### TortoiseGit ### TortoiseGit
...@@ -35,13 +35,39 @@ commande quand on doit faire des choses compliquées. ...@@ -35,13 +35,39 @@ commande quand on doit faire des choses compliquées.
## 2. Mise en place de l'environnement ## 2. Mise en place de l'environnement
### Fork du projet
Si vous ne faites pas partie de l'équipe de développement de la documentation du
produit, vous pouvez quand même effectuer des modifications puis demander à ce
qu'elles soient appliquées. Si vous êtes membre du projet et que vous avez des
droits en édition vous pouvez sauter cette étape.
Pour cela il faudra faire un **Fork** (ou "fourcher") le dépôt sur votre compte
en cliquant sur le bouton
![Clone fork repo](images/documentation_fork_gitlab1.png) ou
![Clone fork repo fr](images/documentation_fork_gitlab1_1.png) si votre
interface est en Français.
Maintenant GitLab vous demande où stocker le projet, si vous n'appartenez à
aucune organisation, vous devrez le stocker sur votre compte:
![Clone fork repo 2](images/documentation_fork_gitlab2.png)
Désormais le projet à été copié sur votre compte et vous avez tous les droits
dessus car vous en êtes le propriétaire.
![Clone fork repo 3](images/documentation_fork_gitlab3.png)
### Clone
Pour éditer et créer des fichiers de documentation, il faudra **clôner** le Pour éditer et créer des fichiers de documentation, il faudra **clôner** le
dépôt sur lequel vous voulez travailler, ceci va créer une copie de ce dépôt dépôt sur lequel vous voulez travailler, ceci va créer une copie de ce dépôt
hébergé sur GitHub dans un dossier de votre ordinateur. Pour cela, rendez-vous dans un dossier de votre ordinateur. Pour cela, rendez-vous sur la page
sur la page GitHub du dépôt sur lequel vous voulez travailler, cliquez sur le [GitLab de Veremes](http://vm09.veremes.net) du dépôt sur lequel vous voulez
bouton _Clone or download_ puis copiez ladresse qui apparaît. travailler, puis copiez l'adresse qui apparaît.
![Clone github repo](images/documentation_clone_github.png) ![Clone gitlab repo](images/documentation_clone_gitlab.png)
Créez ensuite un répertoire sur votre poste où vous souhaitez stocker les Créez ensuite un répertoire sur votre poste où vous souhaitez stocker les
dépôts ; si vous êtes sous Windows, faites un clic droit puis "Open Git bash dépôts ; si vous êtes sous Windows, faites un clic droit puis "Open Git bash
...@@ -49,7 +75,7 @@ here" ; si vous êtes sous Linux, rendez-vous simplement dans ce dossier. ...@@ -49,7 +75,7 @@ here" ; si vous êtes sous Linux, rendez-vous simplement dans ce dossier.
Maintenant que vous êtes sur votre terminal git, lancez la commande suivante Maintenant que vous êtes sur votre terminal git, lancez la commande suivante
en prenant soin de remplacer l'url par celle que vous avez copié précédemment. en prenant soin de remplacer l'url par celle que vous avez copié précédemment.
``` ```
git clone https://github.com/Veremes/doc_Vitis.git git clone http://vm09.veremes.net/Documentation/doc_app_vmap.git
``` ```
Maintenant que vous avez rapatrié le dépôt chez vous, vous pouvez l'ouvrir Maintenant que vous avez rapatrié le dépôt chez vous, vous pouvez l'ouvrir
...@@ -96,6 +122,42 @@ les envoyer sur le serveur ; pour cela, utilisez le bouton **Push**. ...@@ -96,6 +122,42 @@ les envoyer sur le serveur ; pour cela, utilisez le bouton **Push**.
![Fichiers modifiés git atom 4](images/documentation_git_atom_4.png) ![Fichiers modifiés git atom 4](images/documentation_git_atom_4.png)
Désormais, vos modifications sont directement visibles sur l'interface GitHub de Désormais, vos modifications sont directement visibles sur l'interface GitLab du
votre projet, et si ce dernier est correctement lié à une page Readthedocs, il projet.
suffira de quelques minutes pour les voir apparaître.
### Demande de Merge
Si vous avez effectué un **Fork** du projet les modifications effectuées se
situent sur le projet précédemment copié sous votre compte, pour que les
modifications puissent être effectives sur le projet officiel, vous pouvez
demander un **merge** aux administrateurs.
Pour cela cliquez sur le bouton *New merge request*:
![Merge request 1](images/documentation_merge_gitlab1.png)
Sélectionnez la source et la destination puis lancez la comparaison des branches.
Sur cet exemple nous avions modifiés le fichier Readme.md il apparaît donc sur
l'interface
![Merge request 2](images/documentation_merge_gitlab2.png)
Écrivez un titre à votre demande
![Merge request 3](images/documentation_merge_gitlab3.png)
Cliquez sur le bouton *Submit demande de fusion*
![Merge request 4](images/documentation_merge_gitlab4.png)
Votre merge a été demandé
![Merge request 5](images/documentation_merge_gitlab5.png)
### Fin
Désormais, vos modifications sont directement visibles sur l'interface GitLab du
projet officiel, et si ce dernier est correctement lié à une page Readthedocs,
il suffira de quelques minutes pour les voir apparaître sur la documentation
en ligne.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment