From 15ea75fea6ecedb32df80382cdb84eb68c031374 Mon Sep 17 00:00:00 2001 From: Olivier Maury <Olivier.Maury@inrae.fr> Date: Wed, 11 Dec 2024 11:35:05 +0100 Subject: [PATCH] Corriger des typos et ajouter des notes pour la session 2 --- 02_gitlab_depot_distant/02_rappels.qmd | 4 +-- .../03_pre_requis_session2.qmd | 2 +- .../06_configuration_gitlab.qmd | 21 +++++++++++-- .../08_commandes_initiales.qmd | 7 ++++- 02_gitlab_depot_distant/09_navigation.qmd | 4 +++ .../10_gestion_membres.qmd | 31 +++++-------------- 02_gitlab_depot_distant/11_issues.qmd | 12 +++---- 02_gitlab_depot_distant/index.qmd | 3 +- 03_branches/index.qmd | 4 +-- 9 files changed, 50 insertions(+), 38 deletions(-) diff --git a/02_gitlab_depot_distant/02_rappels.qmd b/02_gitlab_depot_distant/02_rappels.qmd index b4ea802..5a8b563 100644 --- a/02_gitlab_depot_distant/02_rappels.qmd +++ b/02_gitlab_depot_distant/02_rappels.qmd @@ -6,7 +6,7 @@ Nous avons vu : * l'intérêt de l'usage d'un outil comme Git * les différents états d'un dépôt local -* les commandes principales selon 3 modes: +* les commandes principales selon 3 modes : - en ligne de commande  - avec RStudio {width="10%"} @@ -22,4 +22,4 @@ Nous avons vu : * Bonnes pratiques pour les commits (atomique, message) * Consulter l'historique sur le dépôt (`git log`) * Annuler des modifications (`git restore`, `git reset`) -* Voir des modifications (`git diff`) \ No newline at end of file +* Voir des modifications (`git diff`) diff --git a/02_gitlab_depot_distant/03_pre_requis_session2.qmd b/02_gitlab_depot_distant/03_pre_requis_session2.qmd index 6657283..fc6ab24 100644 --- a/02_gitlab_depot_distant/03_pre_requis_session2.qmd +++ b/02_gitlab_depot_distant/03_pre_requis_session2.qmd @@ -14,6 +14,6 @@ Choisissez un projet : - un autre projet existant avec un dépôt Git - créer un nouveau projet et initialiser le dépôt Git -Vous pouvez faire des modifications, commiter les modifications, parcourir l'historique… soit en ligne de commande, avec RStudio ou avec VS Code. +Vous pouvez faire des modifications, commiter les modifications, parcourir l'historique… en ligne de commande, avec RStudio ou avec VS Code. ::: diff --git a/02_gitlab_depot_distant/06_configuration_gitlab.qmd b/02_gitlab_depot_distant/06_configuration_gitlab.qmd index 6a7abfb..2874c80 100644 --- a/02_gitlab_depot_distant/06_configuration_gitlab.qmd +++ b/02_gitlab_depot_distant/06_configuration_gitlab.qmd @@ -7,6 +7,10 @@ {fig-align="center" width=60%} +::: {.notes} +L'interface de GitLab est aussi disponible dans différentes langues dont le français et aussi en thème clair et sombre. +::: + ## Définition d'une clé SSH Une clé SSH (Secure Shell) est un protocole réseau qui permet : @@ -19,6 +23,10 @@ La clé SSH est composée d'une clé privée et d'une clé publique. Plus d'informations sur [la page SSH de GitLab](https://forgemia.inra.fr/help/user/ssh.md){target="_blank"}. +::: {.notes} +Une autre méthode pour faire communiquer Git et le dépôt distant utilise des jetons. +::: + ## Création d'une clé SSH ::: {.panel-tabset} @@ -58,14 +66,23 @@ Plus d'informations sur [la page SSH de GitLab](https://forgemia.inra.fr/help/us TODO +Git-Gui est installé sous Windows avec Git. + +Menu _Help_ > _Show SSH keys_ ::: ## Dans GitLab -- Dans GitLab aller dans `Edit Profil` > `SSH Keys` > `Add new key` +- Dans GitLab, aller dans 1) `Edit Profil` > 2) [`SSH Keys`](https://forgemia.inra.fr/-/user_settings/ssh_keys){target="_blank"}, puis cliquer sur `Add new key` 3) Coller la clé générée précédemment 4) Renseigner le nom associé à la clé 5) Ne pas saisir de date d'expiration - {width=70% fig-align="center"} + +::: {.notes} +Les valeurs de clefs publiques ED25519 et RSA à coller ressemblent à + +- ssh-ed25519 AAAAZ1Zzz... monnom@monposte +- ssh-rsa BBBBY2Yyy...= nomnom@monposte +::: diff --git a/02_gitlab_depot_distant/08_commandes_initiales.qmd b/02_gitlab_depot_distant/08_commandes_initiales.qmd index f9d65e1..b98d535 100644 --- a/02_gitlab_depot_distant/08_commandes_initiales.qmd +++ b/02_gitlab_depot_distant/08_commandes_initiales.qmd @@ -14,6 +14,7 @@ Dans la suite de la présentation, les lignes de commande \<namespace\> et \<pro - Je souhaite envoyer un dépôt local existant sur GitLab ::: callout-tip +### Remarque Les commandes sont affichées sur la page d'accueil du projet, lors de la création d'un dépôt vide. 3 cas : @@ -58,6 +59,11 @@ Pour cloner un dépôt existant il faut créer un nouveau projet R et renseigner Après `Create Project` le dépôt GitLab sera disponible en local sur votre machine. +## Avec VS Code +{.absolute top=-10 right=0 width="10%"} +Il n'y a pas de menu pour cloner un dépôt. +Utiliser la ligne de commande. + ::: ## Envoyer un dépôt local vers la forge @@ -125,4 +131,3 @@ Envoyer un projet local sur le dépôt GitLab que vous venez de créer. Cloner sur votre machine le dépôt situé à cette [adresse](https://forgemia.inra.fr/git-gitlab-paca/exercice_session3){target="_blank"}. ::: - diff --git a/02_gitlab_depot_distant/09_navigation.qmd b/02_gitlab_depot_distant/09_navigation.qmd index 6eefb9f..7b9053a 100644 --- a/02_gitlab_depot_distant/09_navigation.qmd +++ b/02_gitlab_depot_distant/09_navigation.qmd @@ -57,6 +57,10 @@ La majorité des options par défaut est adaptée. On peut ajouter un logo et une description au projet dans `Settings` > `General`. +::: {.notes} +Il est très important de décrire le projet pour faciliter l'exploration des nombreux projets qui seront créés dans GitLab. +L'ajout de mots-clefs (_topics_) peut aussi aider à la découverte de projets. +::: {width=70%} diff --git a/02_gitlab_depot_distant/10_gestion_membres.qmd b/02_gitlab_depot_distant/10_gestion_membres.qmd index a21b501..eff7749 100644 --- a/02_gitlab_depot_distant/10_gestion_membres.qmd +++ b/02_gitlab_depot_distant/10_gestion_membres.qmd @@ -2,7 +2,9 @@ ## Membres d’un projet -Par défaut seul le créateur du dépôt peut réaliser des modifications (*commit*). Si dans le cadre d'une collaboration vous souhaitez travailler avec d'autres personnes il suffit de les ajouter comme membres de votre dépôt. +Par défaut seul le créateur du dépôt peut réaliser des modifications (*commit*). + +Si dans le cadre d'une collaboration vous souhaitez travailler avec d'autres personnes il suffit de les ajouter comme membres de votre dépôt. ## Statut d’un membre @@ -25,6 +27,9 @@ Pour inviter d’autres utilisateurs à contribuer au projet, il faut les invite {fig-align="center"} +::: {.notes} +[Comment créer un compte sur ForgeMIA (hors ESR) ?](https://forgemia.inra.fr/adminforgemia/doc-public/-/wikis/FAQ#comment-cr%C3%A9er-un-compte-sur-forgemia-hors-esr-) +::: ------ @@ -35,7 +40,7 @@ Pour configurer le statut du membre : Lorsqu'un utilisateur n'est pas connu de la forge, il faut lui demander de faire une première connexion sur l'adresse <a href="https://forgemia.inra.fr" target="_blank">ForgeMIA</a>, avec son identifiant LDAP. -Il est alors connu de la forge, et vous pouvez l'ajouter sur le projet. +Il est alors connu de la forge et vous pouvez l'ajouter sur le projet. ------ @@ -47,26 +52,6 @@ Il est alors connu de la forge, et vous pouvez l'ajouter sur le projet. Invitez au moins une personne présente aujourd'hui à la formation sur votre projet personnel. -Ajoutez là en tant que *reporter* (ça suffira pour aujourd'hui) +Ajoutez là en tant que *reporter* (ça suffira pour aujourd'hui). ::: - - - - - - - - - - - - - - - - - - - - diff --git a/02_gitlab_depot_distant/11_issues.qmd b/02_gitlab_depot_distant/11_issues.qmd index 202237f..69c05df 100644 --- a/02_gitlab_depot_distant/11_issues.qmd +++ b/02_gitlab_depot_distant/11_issues.qmd @@ -2,12 +2,12 @@ ## Définition -Une *issue* est comme un ticket et permet : +Une *issue* est comme un ticket et permet de : -- de prendre des notes -- d'échanger sur une idée -- d'identifier un problème et le documenter -- de structurer son plan de travail +- prendre des notes, +- échanger sur une idée, +- identifier un problème et le documenter, +- structurer son plan de travail. Plus d'informations sur [les *issues*](https://docs.gitlab.com/ee/user/project/issues/){target="_blank"}. @@ -138,4 +138,4 @@ git commit -m "Correction orthographique. fixes #12" ::: notes Fermer un ticket depuis le message de commit n'est possible que depuis la branche *main*. -::: \ No newline at end of file +::: diff --git a/02_gitlab_depot_distant/index.qmd b/02_gitlab_depot_distant/index.qmd index ceff44b..9b823c1 100644 --- a/02_gitlab_depot_distant/index.qmd +++ b/02_gitlab_depot_distant/index.qmd @@ -16,7 +16,8 @@ editor: visual --- ::: callout-important -Attention, les captures d'écran faites sur Gitlab proviennent d'une ancienne version de la forgeMIA. Cela ne devrait pas impacter la compréhension et la bonne lecture des supports. +Attention, les captures d'écran faites sur GitLab proviennent d'une ancienne version de la forgeMIA. +Cela ne devrait pas géner la compréhension et la bonne lecture des supports. Les supports seront mis à jour au moment du passage à la forge institutionnelle. ::: diff --git a/03_branches/index.qmd b/03_branches/index.qmd index 1c9d0d2..303f0bd 100644 --- a/03_branches/index.qmd +++ b/03_branches/index.qmd @@ -1,8 +1,8 @@ --- -title: "Session 3 : Les branches" +title: "Session 3 : Les branches" format: inrae-revealjs: - footer: "Formation Git / GitLab − Session 3 : les branches" + footer: "Formation Git / GitLab − Session 3 : les branches" slide-number: true show-slide-number: all mouse-wheel: true -- GitLab