mineweb / docs.mineweb.org

MineWebCMS's documentation

Documentation du CMS MineWeb.

Présentation

La documentation de mineweb.org regroupe toutes les informations nécessaires au bon fonctionnement du CMS MineWeb ainsi que des tutoriels sur la création d'extensions ou sur la liaison avec le serveur. Ce repo vous permet de contribuer à la documentation grâce au système de Pull-Request de Github permettant ainsi à la documentation d'être plus complète. La documentation est au format Markdown et utilise la librairie Slate.

Comment contribuer ?

Nous vous remercions de votre contribution. Veillez à faire le moins possible de fautes aussi bien de français que dans vos informations. Votre contribution sera bien sûr vérifiée avant d'être validée

Pour contribuer, il vous faut tout simplement cloner ce repo, et faire vos modifications directement dans source/. Une fois vos modifications apportées, soumettez-nous une pull-request.

Comment éditer une section

Pour éditer une section déjà présente sur le CMS il vous suffit d'éditer le fichier de la section correspondante se situant dans source/includes.

Comment ajouter une section

Pour ajouter une section, il vous suffit de rajouter un fichier source/includes/ au format _{Nom de la section}.md. Il faudra également ajouter le nom de votre section dans le fichier source/index.html.md dans la liste includes. Il vous suffira ensuite de remplir la section comme vous le souhaitez.

docs.mineweb.org's Issues

Les informations sur le copyright sont fausses

La licence sur laquelle mineweb est basée (GNU GPL 3.0) n'oblige pas les utilisateurs à garder la mention dans le pied de page.

Ce serait contraire à la philosophie de l'open-source. Aucune licence open-source ne force ça.

Par contre, la licence empêche les utilisateurs de retirer les mentions dans les fichiers sources (par exemple les @author de JSDoc et autres commentaires du même genre).

Si vous voulez, je peux faire un pull request avec les modifications requises pour rester compatible avec la GPL.