Commit 3f421a79 authored by Hugues Pecout's avatar Hugues Pecout
Browse files

final

parent 12b265ee
Pipeline #7818 passed with stage
in 30 seconds
...@@ -42,7 +42,7 @@ opts_knit$set(width=75) ...@@ -42,7 +42,7 @@ opts_knit$set(width=75)
# Introduction # Introduction
Une fois votre fiche rédigée, vous devriez être en posssession d'un répertoire contenant les fichiers et sous-répertoires ci-dessous. Comme indiqué dans la [documentation](https://rzine.gitpages.huma-num.fr/Help_Rzine_Layout/), **les fichiers** *biblio.bib* **et** *featured.png* **ne sont pas obligatoires** : Une fois votre fiche rédigée, vous devriez être en possession d'un répertoire contenant les fichiers et sous-répertoires suivants. Comme indiqué dans la [documentation](https://rzine.gitpages.huma-num.fr/Help_Rzine_Layout/), **les fichiers** *biblio.bib* **et** *featured.png* **ne sont pas obligatoires** :
```{r, echo=FALSE, fig.align='center', out.width = "25%"} ```{r, echo=FALSE, fig.align='center', out.width = "25%"}
include_graphics("figures/folder_fiche.png") include_graphics("figures/folder_fiche.png")
...@@ -56,17 +56,17 @@ include_graphics("figures/folder_fiche.png") ...@@ -56,17 +56,17 @@ include_graphics("figures/folder_fiche.png")
include_graphics("figures/folder_fiche_2.png") include_graphics("figures/folder_fiche_2.png")
``` ```
**Vous pouvez alors soumettre votre travail au comité de lecture Rzine**. Pour cela, vous allez devoir : **Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine**. Pour cela, vous allez devoir :
1) **Déposer votre travail sur un dépôt Git** ([logiciel de gestion de versions décentralisé](https://fr.wikipedia.org/wiki/Git)). 1) **Déposer votre travail sur un dépôt Git** ([logiciel de gestion de versions décentralisé](https://fr.wikipedia.org/wiki/Git)).
2) **Déployer la fiche en format HTML depuis le dépôt Git** pour la rendre consultable en ligne. 2) **Déployer la fiche en format HTML depuis le dépôt Git** pour la rendre consultable en ligne.
3) **Contacter le comité de lecture** en lui fournissant l'adresse du dépôt. 3) **Contacter le comité de lecture** en lui fournissant l'adresse du dépôt.
**Ne soyez pas inquiet si vous n'avez aucune connaissance de Git, ce document détaille les différentes étapes a réaliser. Profitez-en pour vous former à cet outil puissant qui change la vie !** **Ne soyez pas inquiet si vous n'avez aucune connaissance de Git, ce document détaille clairement toutes les étapes à réaliser. Profitez-en pour vous former à cet outil puissant qui change la vie !**
# Premiers pas sur Github # Premiers pas sur Github
**Le logiciel de gestion de versions décentralisé à utiliser pour la soumission est** le plus connu et le plus utilisé dans le monde : [**GitHub**](https://github.com/). La première chose à faire est donc de vous créer un compte **GitHub**. **Le logiciel de gestion de versions décentralisé à utiliser pour la soumission est** le plus connu et le plus utilisé dans le monde : [**GitHub**](https://github.com/). La première chose à faire est donc de vous créer un compte.
## Création de compte ## Création de compte
...@@ -77,7 +77,9 @@ include_graphics("figures/folder_fiche_2.png") ...@@ -77,7 +77,9 @@ include_graphics("figures/folder_fiche_2.png")
include_graphics("figures/email_github.png") include_graphics("figures/email_github.png")
``` ```
**Saisissez le courriel que vous souhaitez utiliser, un mot de passe, un nom d'utilisateur et répondez aux questions de sécurité pour créer votre compte.** Un code de sécurité vous sera envoyé au courriel renseigné afin de valider la création du compte. **Saisissez le courriel que vous souhaitez utiliser, un mot de passe, un nom d'utilisateur et répondez aux questions de sécurité pour créer votre compte.** Un code de sécurité vous sera envoyé au courriel renseigné afin de valider la création du compte...
## Création d'un dépôt
Vous avez désormais un compte GitHub : Vous avez désormais un compte GitHub :
...@@ -85,23 +87,22 @@ Vous avez désormais un compte GitHub : ...@@ -85,23 +87,22 @@ Vous avez désormais un compte GitHub :
include_graphics("figures/welcome_github.png") include_graphics("figures/welcome_github.png")
``` ```
**Cliquez sur** "***Start a project***" **pour créer un dépôt qui hébergera votre fiche**. **Cliquez sur** "***Start a project***" ou "***Create repository***" **pour créer un dépôt qui hébergera votre fiche**.
## Création d'un dépôt
Si vous n'avez pas cliqué sur "***Start a project***" à la fin de l'étape précedente, vous pouvez créer un nouveau dépot en cliquant sur "***+***" puis "***New repository***" en haut à droite de la fenêtre : Vous pouvez également créer un nouveau dépôt en cliquant sur "***+***" puis "***New repository***" en haut à droite de la fenêtre :
```{r, echo=FALSE, fig.align='center', out.width = "40%"} ```{r, echo=FALSE, fig.align='center', out.width = "40%"}
include_graphics("figures/new_repo.png") include_graphics("figures/new_repo.png")
``` ```
Un fois sur la page de création d'un nouveau dépôt, **saisissez un nom de dépôt** (sans espace ni caractère spéciaux) et éventuellement une description. **Initialisez ce dépôt comme** ***Public*** et **demandez l'ajout automatique d'un fichier** ***README.md*** : Un fois sur la page de création d'un nouveau dépôt, **saisissez un nom de dépôt** (sans espaces ni caractères spéciaux) et éventuellement une description. **Initialisez ce dépôt comme** ***Public*** et **demandez l'ajout automatique d'un fichier** ***README.md*** :
```{r, echo=FALSE, fig.align='center', out.width = "70%"} ```{r, echo=FALSE, fig.align='center', out.width = "70%"}
include_graphics("figures/create_repo.png") include_graphics("figures/create_repo.png")
``` ```
Puis cliquez sur "***Create repository***". **Votre dépot (vide) a été créé :** Puis cliquez sur "***Create repository***". **Votre dépôt**, uniquement rempli d'un fichier README.md, **a été créé :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"} ```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/new_repo_2.png") include_graphics("figures/new_repo_2.png")
...@@ -111,7 +112,7 @@ include_graphics("figures/new_repo_2.png") ...@@ -111,7 +112,7 @@ include_graphics("figures/new_repo_2.png")
**Vous pouvez désormais y ajouter le répertoire contenant tous les fichiers (et sous-répertoires) de votre Fiche**. **Vous pouvez désormais y ajouter le répertoire contenant tous les fichiers (et sous-répertoires) de votre Fiche**.
**Il existe plusieurs méthodes pour téléverser des fichiers sur GitHub (en ligne de commande ou en clic-bouton)**. Nous présentons ici la méthode clic-bouton depuis l’interface de GitHub. **Il existe plusieurs méthodes pour téléverser des fichiers sur GitHub (en ligne de commande ou en clic-bouton). Nous présentons ici la méthode clic-bouton depuis l’interface de GitHub**.
Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :. Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :.
...@@ -119,7 +120,7 @@ Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :. ...@@ -119,7 +120,7 @@ Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :.
include_graphics("figures/upload_file.png") include_graphics("figures/upload_file.png")
``` ```
**Faîtes glisser l'ensemble des fichiers et sous-répertoires de votre fiche dans le dépot** : **Faîtes glisser l'ensemble des fichiers et sous-répertoires de votre fiche dans le dépôt** :
```{r, echo=FALSE, fig.align='center', out.width = "100%"} ```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/drag_files.png") include_graphics("figures/drag_files.png")
...@@ -131,21 +132,21 @@ include_graphics("figures/drag_files.png") ...@@ -131,21 +132,21 @@ include_graphics("figures/drag_files.png")
include_graphics("figures/commit_changes.png") include_graphics("figures/commit_changes.png")
``` ```
**Vous venez de réaliser votre premier** ***commit*** (enregistrement des changements). **L'ensemble des fichiers sont désormais stockés sur le dépôt précedemment créé :**. **Vous venez de réaliser votre premier** "***commit***" (enregistrement des changements). **L'ensemble des fichiers sont désormais stockés sur le dépôt :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"} ```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/commit.png") include_graphics("figures/commit.png")
``` ```
Comme vous avez déclaré ce dépôt *Public*, **tout le monde peut désormais consulter et récupérer ces fichiers**. Ce dépôt étant paramétré comme *Public*, **tout le monde peut désormais consulter et récupérer ces fichiers**.
# Déploiement de la fiche # Déploiement de la fiche
Les fichiers sont consultables à l'état brut. **Une manipulation supplémentaire va permettre de mettre en ligne votre fiche en format HTML**. **Cela permet de rendre votre fiche mise en page consultable par tout le monde sur le web**, sans devoir gérer un serveur, un site web... C'est trés utile, et très facile à faire ! Les fichiers sont consultables à l'état brut, mais **une manipulation supplémentaire va permettre de mettre en ligne votre fiche (format HTML)**. **Votre fiche mise en page sera ainsi consultable par tout le monde sur le web**, sans avoir à gérer un serveur ou un site web. C'est trais utile, et très facile à faire !
## GitHub Page ## GitHub Page
**Cliquez sur** "***Settings > Pages > Source (none)***" et séléctionnez la branche "***main***" : **Cliquez sur** "***Settings > Pages > Source (none)***" et sélectionnez la branche "***main***" :
```{r, echo=FALSE, fig.align='center', out.width = "100%"} ```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/deploy.png") include_graphics("figures/deploy.png")
...@@ -154,7 +155,7 @@ include_graphics("figures/deploy.png") ...@@ -154,7 +155,7 @@ include_graphics("figures/deploy.png")
<div class="alert alert-danger" role="alert"> <div class="alert alert-danger" role="alert">
**Pour que cela fonctionne, le fichier html à déployer (et le rmd pour plus de cohérence) doivent impérativement avoir été renommés** "***index***". (Cf. [introduction](#introduction)) </div> **Pour que cela fonctionne, le fichier html à déployer (et le rmd pour plus de cohérence) doivent impérativement avoir été renommés** "***index***". (Cf. [introduction](#introduction)) </div>
**Ne modifiez pas le répertoire ciblé par défault** **(**"***root***"**)** qui indique la racine du dépôt. **Cliquez sur** "***save***" **:** **Ne modifiez pas le répertoire ciblé par défaut** **(**"***root***"**)** qui indique la racine du dépôt. **Cliquez sur** "***save***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "80%"} ```{r, echo=FALSE, fig.align='center', out.width = "80%"}
include_graphics("figures/GitHub_Pages.png") include_graphics("figures/GitHub_Pages.png")
...@@ -162,10 +163,10 @@ include_graphics("figures/GitHub_Pages.png") ...@@ -162,10 +163,10 @@ include_graphics("figures/GitHub_Pages.png")
**Félicitations ! Votre fiche est désormais consulatble en ligne depuis votre compte GitHub !** **Félicitations ! Votre fiche est désormais consultable en ligne depuis votre compte GitHub !**
**La page html est alors distribuée à l'adresse suivante : https://**`username`**.gitub.io/**`repository_name`**/**. **La page html est alors distribuée à l'adresse suivante : https://**`username`**.gitub.io/**`repository_name`**/**.
**Vous pouvez retrouver l'URL d'accès dans le menu** "***Setting > Pages***" **:** **Vous pouvez retrouver l'URL d'accès dans le menu** "***Settings > Pages***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "90%"} ```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/deploy_url.png") include_graphics("figures/deploy_url.png")
...@@ -179,15 +180,15 @@ include_graphics("figures/online.png") ...@@ -179,15 +180,15 @@ include_graphics("figures/online.png")
## README.md ## README.md
**Le fichier markdown** "***README***" **contient les informations importantes à propos du dépôt en question**. **Son contenu est automatiquement affiché** (et mise en forme grâce à la syntaxe markdown) **en dessous des fichiers listés du dépôt**. **Le fichier markdown** "***README***" est utilisé **pour présenter les informations importantes à propos du dépôt**. **Son contenu est automatiquement affiché** (et mise en forme grâce à la syntaxe markdown) **en dessous des fichiers listés du dépôt**.
**Il est possible de l'éditer et de le modifier facilement depuis l'interface GitHub** en cliquant sur le **symbol crayon** : **Il est possible de l'éditer et de le modifier facilement depuis l'interface GitHub** en cliquant sur le **symbole crayon** :
```{r, echo=FALSE, fig.align='center', out.width = "90%"} ```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/readme.png") include_graphics("figures/readme.png")
``` ```
**Cliquez sur le symbol**, et **copiez-collez ces quelques lignes** dans le fichier édité en ligne : **Cliquez sur le symbole**, et **copiez-collez ces quelques lignes** dans le fichier édité en ligne :
``` ```
# Fiche Rzine # Fiche Rzine
...@@ -209,7 +210,7 @@ Cette fiche présente.... ...@@ -209,7 +210,7 @@ Cette fiche présente....
include_graphics("figures/readme2.png") include_graphics("figures/readme2.png")
``` ```
**Et voilà ! vous avez terminé la mise en ligne de votre fiche**. Désormais, **un lien vers votre fiche déployée est affiché à la racine du dépot :** **Et voilà ! vous avez terminé la mise en ligne de votre fiche**. Désormais, **un lien vers votre fiche déployée est affiché à la racine du dépôt grâce au fichier** "***README.md***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "100%"} ```{r, echo=FALSE, fig.align='center', out.width = "100%"}
...@@ -220,7 +221,7 @@ include_graphics("figures/final.png") ...@@ -220,7 +221,7 @@ include_graphics("figures/final.png")
Il ne vous reste plus qu'à **contacter le comité de lecture Rzine pour soumettre votre fiche à évaluation**. Pour cela, **envoyez un courriel à** [**contact@rzine.fr**](mailto:contact@rzine.fr), en **précisant l'adresse du dépôt qui héberge votre fiche.** Il ne vous reste plus qu'à **contacter le comité de lecture Rzine pour soumettre votre fiche à évaluation**. Pour cela, **envoyez un courriel à** [**contact@rzine.fr**](mailto:contact@rzine.fr), en **précisant l'adresse du dépôt qui héberge votre fiche.**
**Vous serez contacté par le commité de lecture dans les 15 jours suivants l'envoi de ce courriel.** **Vous serez contacté par le comité de lecture dans les 15 jours suivants l'envoi de ce courriel.**
# Processus de relecture ? # Processus de relecture ?
...@@ -228,7 +229,7 @@ En cas de soumission validée, **un relecteur·rice doté·e des connaissances t ...@@ -228,7 +229,7 @@ En cas de soumission validée, **un relecteur·rice doté·e des connaissances t
**Rzine est dans une démarche volontariste d’Open Science. La relecture des fiches Rzine est ouverte et transparente**. L’identité du ou des relecteur·rice·s et l'ensemble de leurs retours sont publics. **Rzine est dans une démarche volontariste d’Open Science. La relecture des fiches Rzine est ouverte et transparente**. L’identité du ou des relecteur·rice·s et l'ensemble de leurs retours sont publics.
**Parce qu'une fiche est un document computationel, l'ensemble du processus se déroule sur GitHub**. Vous serez donc invité·e à ouvrir les droits du dépôt GitHub de votre fiche au relecteur·rice désigné·e. Les retours et les demandes d’améliorations se feront directement sur la plateforme GitHub via des *issues* et des *pull-request*. **Parce qu'une fiche est un document computationnel, l'ensemble du processus se déroule sur GitHub**. Vous serez donc invité·e à ouvrir les droits du dépôt GitHub de votre fiche au relecteur·rice désigné·e. Les retours et les demandes d’améliorations se feront directement sur la plateforme GitHub via des *issues* et des *pull-request*.
**Une documentation complète est mise à votre disposition** [**ici**](https://rzine.gitpages.huma-num.fr/help_rzine_reviewing/), **pour vous accompagner dans le processus de relecture**. Les [éditeurs du comité de lecture](https://rzine.fr/collection/#people) pourront également vous assister dans ce processus. **Une documentation complète est mise à votre disposition** [**ici**](https://rzine.gitpages.huma-num.fr/help_rzine_reviewing/), **pour vous accompagner dans le processus de relecture**. Les [éditeurs du comité de lecture](https://rzine.fr/collection/#people) pourront également vous assister dans ce processus.
......
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment