doc.spaceint.fr

Ce dépôt a pour vocation de rendre disponible les sources du site de documentation de SpaceInt.

1 - Contenu

Dans le dossier sources, vous retrouverez tous les fichiers MarkDown qui permettent la création d'une documentation.

Description de chaque fichier :

- retype.yml -> Fichier de configuration principale du site
- logo_no_background.png -> Logo du site
- favicon.ico -> Icon dans l'onglet
- index.md -> équivalent du index.html d'un site, racine du site.

2 - Contribution

Si vous souhaitez contribuer à notre documentation, vous pouvez faire une pull request sur Gitea. Pour ce faire, vous devez avoir un compte sur notre Gitea et récupérer le dépôt git.

Vous devez rédiger chaque fichier en MarkDown, sinon on ne pourra pas les builds. Vos fichiers doivent respecter ces règles-ci :

- Français correcte (Le moins de fautes de français possible, aucun language vulgaire)
- Un sommaire
- Nom de l'auteur, cela peut être votre nom et prénom comme votre pseudo, un tag Discord, un lien Twitter
- Restez dans le sujet, vous devez être au minimum dans le sujet de l'informatique ou du numérique. (Cela peut toucher à du Linux, comme parler de l'utilisation du numérique par exemple)
- Les commits et pull requests doivent être claires ! On doit savoir ce que c'est avant d'aller dessus

Concernant les pulls requests, vous devez rentrer dans un dossier sujet ou en créer un si celui-ci n'est pas déjà présent. Par exemple, vous parlez de réseau, le dossier sujet réseau n'est pas présent, vous pouvez le créer et mettre votre fichier MarkDown avec le titre de votre article en tant que nom de fichier. (Exemple : Réseau/Les vlans.md)

Pour savoir comment faire du MarkDown : le Cheat Sheet (vous pouvez aussi faire du HTML en MarkDown)

3 - Comment refaire le site ?

Si vous souhaitez utiliser notre site comme base pour votre documentation, vous devez passer par du NodeJS et NPM, vous devez utiliser votre gestionnaire de paquets favoris pour les installer.

Exemple sur ArchLinux :

sudo pacman -S nodejs npm

À partir de là, vous devez installer ReType, le moteur qui vient générer par la suite le site statique en HTML et CSS :

sudo npm install retypeapp --global

De là, maintenant vous pouvez vous rendre dans le dossier sources ou dans le dossier que vous souhaitez pour faire votre site de documentation.

Pour avoir une mise à jour en directe du site tapez retype watch et pour build le site retype build

Pour plus d'explications, vous pouvez aller sur le site de ReType.