Contribuer à la documentation
Traduction anglaise: Contribute to the documentation
La documentation est un pilier essentiel de tout projet open source. En contribuant vous permettez de rendre la plateforme plus facile d'accès. Merci à vous 👍.
Documenter ne nécessite aucune compétence technique particulière.
Communauté autour de la documentation : communecter.org/#codocwiki
Selon votre profil il existe 3 portes d'entrée :
Si vous souhaitez éditer la documentation il faut vous inscrire sur github. C'est rapide et gratuit 😄.
- Cliquez ici et remplissez le petit formulaire
- À la 2ème étape choisissez "Unlimited public repositories for free"
- Sautez la 3ème étape en cliquant sur "skip this step" à côté du bouton "Submit"
- Ouvrez vos mails pour valider votre adresse
- Cliquez sur le bouton "Éditer"
- Cliquez sur "Save Page"
Votre modification sera affichée sur wiki.communecter.org après de la mise à jour automatique qui a lieu chaque nuit.
Pour mettre à jour manuellement wiki.communecter.org il faut lancer le script sur cette page (le chargement prendra une dizaine de secondes).
- Accédez au wiki via Github
- Cliquer sur "New Page" à côté du bouton "Edit".
Le nom des pages du wiki ne doit pas contenir de caractères spéciaux comme "?" ou "(" ou ":" par exemple.
Markdown est le langage utilisé par github (et Communecter) pour mettre en forme du texte. Exemples : **Texte en gras** _Texte en italique_.
Il existe de nombreux guides pour débuter. En voici un : pense-bête markedown.
Si son usage vous fait peur, il existe des éditeurs visuels comme StackEdit.
Le sommaire dans la barre latérale de droite doit contenir des pages du wiki sous forme de [[liens internes]]. Il ne peut pas contenir de liens externes.
Le # titre de 1er niveau doit systématiquement apparaître en début de page et indique le nom de la page. Les ## et ### peuvent être utilisés comme on le souhaite après dans la page.
Dans l'ensemble du wiki, les liens internes doivent toujours être notés [[Nom de la page]] et jamais [Nom de la page](https://github.com/pixelhumain/wiki/wiki/Nom-de-la-page).
Les images doivent être partagées via le cloud de communecter.
Un script automatique convertit le wiki de Github vers un format interprété par Gitbook. En savoir + : Gitbook - configuration.
- Pourquoi la documentation compte ? - Sarah Haïm-Lubczanski - PHP Tour Lyon 2014
- Comment écrire une documentation logicielle - WikiHow