Commit 68385711 authored by  JosephK's avatar JosephK
Browse files

doc pour contribuer à la doc #3

parent 782203f4
......@@ -7,7 +7,101 @@ If you want to work with us, **fork us on [framagit.org](https://framagit.org)**
Si vous souhaitez travailler avec nous, **forkez-nous sur [framagit.org](https://framagit.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
* * *
Documentation centrale (basée sur Gitbook) pour l’ensemble des services Framasoft.
Documentation centrale (basée sur Gitbook) pour l’ensemble des services Framasoft.
[docs.framasoft.org](https://docs.framasoft.org)
* * *
## Contribuer à la documentation
### Rédaction
Les fichiers sont rédigés avec [la syntaxe markdown](https://docs.framasoft.org/fr/mattermost/help/messaging/formatting-text.html)
mais Gitbook accepte aussi la syntaxe HTML.
Par contre, il n'est pas possible de mixer les 2 syntaxes dans un même bloc.
Si vous voulez ajouter des liens internes, il faut faire attention à pointer vers
les pages `.html` correspondantes au `.md` du dossier.
La page d'accueil de la doc du Framaprojet peut contenir une
partie présentation + prise en main rapide + lien vers le logiciel source
et une partie présentation du logiciel source (ça peut être issu de la doc officielle)
+ table des matières avec la liste des pages qu'on trouvera dans le sous-menu à gauche.
### Méthode de travail
https://framagit.org/spf/Tutos/blob/master/Git/translate.md
(voir si le tuto est adapaté pour la documentation)
1. Forker
2. Créer une branche
3. Faire les changements (commit)
4. Demander à intégrer les changements (merge request)
5. Discuter / rectifier
### Structure
Les documentations anglaise et française sont totalement indépendantes.
La documentation de chaque Framaprojet doit être enregistrée dans un dossier
correspondant au nom du logiciel source (exemple : Framacarte → dans le dossier `umap`).
Dans ce dossier, créer un dossier `images` contenant les captures d'écran
et un fichier `README.md` qui contiendra la page d'accueil de présentation du projet
Pour ajouter ensuite le Framaprojet dans la colonne de gauche et sur la page d'accueil,
il faut éditer les fichiers `SUMMARY.md` et `README.md` (à la racine dans le dossier `fr`).
Dans `SUMMARY.md`, il n'est pas possible d'afficher une arborescence
de plus de 2 niveaux et les titres ne sont pas pris en compte
(ils ne sont laissés qu'à titre indicatif).
Chaque lien `.md` trouvé dans ce fichier sera pris en compte par Gitbook
pour créer le fichier `.html` correspondant.
Les fichiers qui ne s'y trouvent pas seront placé dans le dossier
comme de simples fichiers statiques (au même titre que les images)
## Créer une copie locale de la documentation
Pour avoir un aperçu du rendu du site il peut être souhaitable d'installer Gitbook localement.
### Installation de Gitbook
Installez NodeJS, NPM et le client Gitbook :
sudo apt-get install nodejs-legacy npm
sudo npm install gitbook-cli -g
### Générer la documentation
Clonez votre fork de la documentation
git clone https://framagit.org/framasoft/docs.git
Depuis le dossier `docs` procédez à l'installation des plugins requis
(la liste des plugins et leur configuration se trouve dans le fichiers `book.json`)
cd docs
gitbook init
gitbook install
gitbook serve
Si tout s'est bien déroulé (la commande se termine par `Serving book on…`,
la copie du site peut être consultée sur :
http://localhost:4000/
La mise en forme diffère légèrement du site officiel
à cause de la Framanav qui a une configuration particulière.
Chaque changement dans les fichiers entrainera un redémarrage automatique
du serveur nodejs pour qu'ils soient pris en compte
ce qui peut être lourd à la longue.
Si vous disposez d'un serveur web en local, plutôt que de se servir du serveur
nodejs, vous pouvez créer le site manuellement avec la commande
gitbook build
et copier le dossier où vous le voulez sur le serveur web.
\ No newline at end of file
Markdown is supported
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