diff --git a/developpement/images/documentation_clone_gitlab.png b/developpement/images/documentation_clone_gitlab.png new file mode 100644 index 0000000000000000000000000000000000000000..ae1e2b04f876112d10b8dcb64cb5fb1d341d1f60 Binary files /dev/null and b/developpement/images/documentation_clone_gitlab.png differ diff --git a/developpement/images/documentation_fork_gitlab1.png b/developpement/images/documentation_fork_gitlab1.png new file mode 100644 index 0000000000000000000000000000000000000000..d79d2bda3aad313e5afd75ee37f945bdf0fef232 Binary files /dev/null and b/developpement/images/documentation_fork_gitlab1.png differ diff --git a/developpement/images/documentation_fork_gitlab1_1.png b/developpement/images/documentation_fork_gitlab1_1.png new file mode 100644 index 0000000000000000000000000000000000000000..4de6f8af19c3761fc22b82a4f517344299e7a27b Binary files /dev/null and b/developpement/images/documentation_fork_gitlab1_1.png differ diff --git a/developpement/images/documentation_fork_gitlab2.png b/developpement/images/documentation_fork_gitlab2.png new file mode 100644 index 0000000000000000000000000000000000000000..ac5fe489c667043f490215f36d7fd033a8dc0bf4 Binary files /dev/null and b/developpement/images/documentation_fork_gitlab2.png differ diff --git a/developpement/images/documentation_fork_gitlab3.png b/developpement/images/documentation_fork_gitlab3.png new file mode 100644 index 0000000000000000000000000000000000000000..5ed45e4c74700e68e9668fa969b99778867cb36f Binary files /dev/null and b/developpement/images/documentation_fork_gitlab3.png differ diff --git a/developpement/images/documentation_merge_gitlab1.png b/developpement/images/documentation_merge_gitlab1.png new file mode 100644 index 0000000000000000000000000000000000000000..fb52e70224da73708ca5fcc1eaf1193266e0170d Binary files /dev/null and b/developpement/images/documentation_merge_gitlab1.png differ diff --git a/developpement/images/documentation_merge_gitlab2.png b/developpement/images/documentation_merge_gitlab2.png new file mode 100644 index 0000000000000000000000000000000000000000..678e6d0b076647dd56b0dc5aa83e070dd085bd8c Binary files /dev/null and b/developpement/images/documentation_merge_gitlab2.png differ diff --git a/developpement/images/documentation_merge_gitlab3.png b/developpement/images/documentation_merge_gitlab3.png new file mode 100644 index 0000000000000000000000000000000000000000..8568b31fb7b4b1142ccb4163a614515f66f74462 Binary files /dev/null and b/developpement/images/documentation_merge_gitlab3.png differ diff --git a/developpement/images/documentation_merge_gitlab4.png b/developpement/images/documentation_merge_gitlab4.png new file mode 100644 index 0000000000000000000000000000000000000000..798fb2a9bf1b9d912f01e149082e09f9d3655a2a Binary files /dev/null and b/developpement/images/documentation_merge_gitlab4.png differ diff --git a/developpement/images/documentation_merge_gitlab5.png b/developpement/images/documentation_merge_gitlab5.png new file mode 100644 index 0000000000000000000000000000000000000000..5effd71d81c7c3a7087051545500144cde6cc01f Binary files /dev/null and b/developpement/images/documentation_merge_gitlab5.png differ diff --git a/developpement/participation_documentation.md b/developpement/participation_documentation.md index 92f46eb6644a6dd6e754b2c152b48a0b13fc6819..22b2c5cfa0616662a56bc05f4ead20665a8d9589 100644 --- a/developpement/participation_documentation.md +++ b/developpement/participation_documentation.md @@ -1,30 +1,30 @@ # Participer à la documentation Readthedocs 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 [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. ## 1. Les outils -### Git/GitHub - +### Git 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 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 -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. + ### Atom Il existe plusieurs logiciels permettant d'écrire au format Markdown ; en 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 -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. ### TortoiseGit @@ -35,13 +35,39 @@ commande quand on doit faire des choses compliquées. ## 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 + ou + 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: + + + +Désormais le projet à été copié sur votre compte et vous avez tous les droits +dessus car vous en êtes le propriétaire. + + + +### Clone + 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 -hébergé sur GitHub dans un dossier de votre ordinateur. Pour cela, rendez-vous -sur la page GitHub du dépôt sur lequel vous voulez travailler, cliquez sur le -bouton _Clone or download_ puis copiez l’adresse qui apparaît. +dans un dossier de votre ordinateur. Pour cela, rendez-vous sur la page +[GitLab de Veremes](http://vm09.veremes.net) du dépôt sur lequel vous voulez +travailler, puis copiez l'adresse qui apparaît. - + 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 @@ -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 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 @@ -96,6 +122,42 @@ les envoyer sur le serveur ; pour cela, utilisez le bouton **Push**.  -Désormais, vos modifications sont directement visibles sur l'interface GitHub de -votre projet, et si ce dernier est correctement lié à une page Readthedocs, il -suffira de quelques minutes pour les voir apparaître. +Désormais, vos modifications sont directement visibles sur l'interface GitLab du +projet. + +### 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*: + + + +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 + + + +Écrivez un titre à votre demande + + + +Cliquez sur le bouton *Submit demande de fusion* + + + +Votre merge a été demandé + + + + +### 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.