Commit a0ac7fc0 authored by Hugues Pecout's avatar Hugues Pecout
Browse files

draft one

parents
Version: 1.0
RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default
EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8
RnwWeave: Sweave
LaTeX: pdfLaTeX
---
title: "Soumettre une fiche Rzine"
subtitle: "Processus de soumission d'une fiche au comité de lecture"
date: "`r Sys.Date()`"
author:
- name: Comité éditorial Rzine
output:
rzine::readrzine:
highlight: kate
number_sections: true
bibliography: biblio.bib
csl: Rzine_citation.csl
logo: "figures/rzine.png"
nocite: |
@*
link_citations: true
licence: "[![licensebuttons by-sa](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0)"
giturl: "[![Code source on GitLab](https://badgen.net/badge/Code%20source%20on%20/GitLab/blue?icon=gitlab)](https://gitlab.huma-num.fr/rzine/help_rzine_submit)"
# doi: "[![DOI:xxx ](https://zenodo.org/badge/DOI/xxx .svg)](xxx )"
---
```{r setup, include=FALSE}
library(knitr)
library(rzine)
## Global options
options(max.print="75")
opts_chunk$set(echo=FALSE,
cache=FALSE,
prompt=FALSE,
tidy=TRUE,
comment=NA,
message=FALSE,
warning=FALSE)
opts_knit$set(width=75)
```
>Ce document décrit la procédure à suivre pour soumettre une fiche Rzine à la relecture.
# 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** :
```{r, echo=FALSE, fig.align='center', out.width = "25%"}
include_graphics("figures/folder_fiche.png")
```
<div class="alert alert-danger" role="alert">
**Avant de commencer le processus de soumission, il est impératif de renommer les fichiers** "***.Rmd***" et "***.html***" de la façon suivante : "***index.Rmd***" et "***index.html***" **!**</div>
```{r, echo=FALSE, fig.align='center', out.width = "22%"}
include_graphics("figures/folder_fiche_2.png")
```
**Vous pouvez alors 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)).
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.
**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 !**
# 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**.
## Création de compte
**Connectez-vous à la** [**page de création de compte GitHub**](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home).
```{r, echo=FALSE, fig.align='center', out.width = "60%"}
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.
Vous avez désormais un compte GitHub :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/welcome_github.png")
```
**Cliquez sur** "***Start a project***" **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 :
```{r, echo=FALSE, fig.align='center', out.width = "40%"}
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*** :
```{r, echo=FALSE, fig.align='center', out.width = "70%"}
include_graphics("figures/create_repo.png")
```
Puis cliquez sur "***Create repository***". **Votre dépot (vide) a été créé :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/new_repo_2.png")
```
# Remplissage du dépôt
**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.
Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :.
```{r, echo=FALSE, fig.align='center', out.width = "45%"}
include_graphics("figures/upload_file.png")
```
**Faîtes glisser l'ensemble des fichiers et sous-répertoires de votre fiche dans le dépot** :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/drag_files.png")
```
**Ajoutez un commentaire et cliquez sur** "***Commit changes***" :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
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éé :**.
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
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**.
# 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 !
## GitHub Page
**Cliquez sur** "***Settings > Pages > Source (none)***" et séléctionnez la branche "***main***" :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/deploy.png")
```
<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>
**Ne modifiez pas le répertoire ciblé par défault** **(**"***root***"**)** qui indique la racine du dépôt. **Cliquez sur** "***save***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "80%"}
include_graphics("figures/GitHub_Pages.png")
```
**Félicitations ! Votre fiche est désormais consulatble en ligne depuis votre compte GitHub !**
**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***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/deploy_url.png")
```
**Cliquez sur le lien affiché pour consulter la fiche mise en ligne :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/online.png")
```
## 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**.
**Il est possible de l'éditer et de le modifier facilement depuis l'interface GitHub** en cliquant sur le **symbol crayon** :
```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/readme.png")
```
**Cliquez sur le symbol**, et **copiez-collez ces quelques lignes** dans le fichier édité en ligne :
```
# Fiche Rzine
Ce dépôt héberge le code source d'une [fiche Rzine](https://rzine.fr/publication_rzine/).
Cette fiche présente....
**Vous pouvez la consulter à ce** [**lien**](https://username.gitub.io/repository_name/)
[![licensebuttons by-sa](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0)
```
**Personnalisez le texte de présentation de la fiche** (*Cette fiche présente...*) et **remplacez l'URL** *https://xxxxxxx.gitub.io/xxxxxxxxx/* **par l'URL correcte de votre fiche déployée.**
**Commentez votre** ***commit***, puis **cliquez sur** ***Commit changes*** pour enregistrer les changements effectués :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
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 :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/final.png")
```
# Soumission
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.**
# Processus de relecture ?
En cas de soumission validée, **un relecteur·rice doté·e des connaissances techniques et thématiques nécessaires sera proposé·e à l'auteur·e** dans les 15 jours.
**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*.
**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.
# Question ?
Pour toute question relative au processus de soumission et de relecture d'une fiche, **vous pouvez contacter le comité éditorial en envoyant un courriel à l'adresse** [**contact@rzine.fr**](mailto:contact@rzine.fr)
# Bibliographie {-}
<div id="refs"></div>
# Annexes {-}
## Infos session {-}
```{r session_info, echo=FALSE}
kableExtra::kable_styling(kable(rzine::sessionRzine()[[1]], row.names = F))
kableExtra::kable_styling(kable(rzine::sessionRzine()[[2]], row.names = F))
```
## Citation {-}
```{r generateBibliography, echo=FALSE}
cat(readLines('cite.bib'), sep = '\n')
```
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