Soumettre une fiche Rzine
Processus de soumission d’une fiche au comité de lecture
Ce document décrit la procédure à suivre pour soumettre une fiche Rzine à la relecture.
1 Introduction
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, les fichiers biblio.bib et featured.png ne sont pas obligatoires :
Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine. Pour cela, vous devez :
- Déposer votre travail sur un dépôt Git (logiciel de gestion de versions décentralisé).
- Déployer la fiche en format HTML depuis le dépôt Git pour la rendre consultable en ligne.
- 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 clairement toutes les étapes à réaliser. Profitez-en pour vous former à cet outil puissant qui change la vie !
2 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. La première chose à faire est donc de vous créer un compte.
2.1 Création de compte
Connectez-vous à la page de création de compte GitHub.
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…
2.2 Création d’un dépôt
Vous avez désormais un compte GitHub :
Cliquez sur “Start a project” ou “Create repository” pour créer un dépôt qui hébergera votre fiche.
Vous pouvez également créer un nouveau dépôt en cliquant sur “+” puis “New repository” en haut à droite de la fenêtre :
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 :
Puis cliquez sur “Create repository”. Votre dépôt, uniquement rempli d’un fichier README.md, a été créé :
3 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” :.
Faîtes glisser l’ensemble des fichiers et sous-répertoires de votre fiche dans le dépôt :
Ajoutez un commentaire et cliquez sur “Commit changes” :
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 :
Ce dépôt étant paramétré comme Public, tout le monde peut désormais consulter et récupérer ces fichiers.
4 Déploiement de la fiche
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 !
4.1 GitHub Page
Cliquez sur “Settings > Pages > Source (none)” et sélectionnez la branche “main” :
Ne modifiez pas le répertoire ciblé par défaut (“root”) qui indique la racine du dépôt. Cliquez sur “save” :
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/.
Vous pouvez retrouver l’URL d’accès dans le menu “Settings > Pages” :
Cliquez sur le lien affiché pour consulter la fiche mise en ligne :
4.2 README.md
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.
Vous pouvez éditer et modifier facilement ce fichier depuis l’interface GitHub en cliquant sur le symbole crayon :