Manuel pour contribuer à la documentation

Pourquoi contribuer ?

Pour donner votre avis !! Cette documentation a pour but d’être participative, s’il y a des point que vous ne comprenez pas, où vous pensez qu’une explication peut être amener différemment cette page est là pour vous expliquer comment apporter votre point de vue.

Si sur certain points technique, vous pensez que la solution apportée est fausse ou qu’une autre solution pourrait résoudre un problème plus efficacement, s’il vous plaît dites le !

Pour l’orthographe, je dois avouer je n’ai pas forcement le temps de me relire sur ce point, si vous voyez une ou plusieurs faute, faites moi signe, je serais ravie que vous me corrigiez :)

Comment est organisée la documentation ?

Toute cette documentation est hébergée sur Github, puis diffusée via le site Read the doc.

Pourquoi Github ?

Github est un GIT, c’est à dire que l’on va stocker des fichiers d’information, du contenu, sur un projet particulier. L’interêt du GIT est d’archiver chaque changement effectués sur un projet. On a ainsi la possibilité de revenir à n’importe quel moment à une sauvegarde du projet.

Github permet aussi à une large communauté de participer aux differents projet.

Il vous faut donc un compte Github pour participer à cette documentation

Comment participer ?

• Créer un compte Github
• Allez sur la page où vous souhaitez apporter des suggestions
• Cliquez sur “Edit on Github” en haut de la page
• Sur la page github qui vient de s’ouvrir cliquez sur l’icon “Edit”
• Faites les modifications qui vous semble important
• Allez en bas de la page et dans la partie “propose file change” indiquez si vous le souhaitez une brève description ainsi qu’une description plus détaillée des changements que vous proposez
• Cliquez sur “propose file change”

Exemple :

• Vous etes sur la page de restauration de la découpeuse laser K40
• Vous avez une ou plusieurs suggestions sur les informations de la page
• Cliquez sur “Edit on Github”

• Sur la page qui vient de s’ouvrir cliquez sur “Edit this file”

• Dans l’éditeur de Github, faites toutes les modifications qui vous semblent nécessaires
• Quand les modifications sont terminées, allez dans le bas de la page, dans le cadre “Propose file change”, indiquez une petite description des changements que vous avez apporté.
• Cliquez sur “Propose file change”

Je pourrais par la suite intégrer vos suggestions, Merci pour la participation !!