Cette section du guide couvre le processus d’installation et l’usage basique des outils necessaire pour changer la documentation

Vous allez avoir besoin des outils suivants:

Installez Git

Pour installer Git sur votre machine faites référence a ce guide.

Pour une brève introduction à l’usage de Git, faites référence à ce guide.

Installez Python

L’installation de Python est assez simple , faites référence au download de la page officielle et suivez les instructions pour votre système d’exploitation. Comme cité ci-dessus par Python 2.7.9 , onward pip est fourni avec Python.

Open the terminal on your machine and type python, the output should resemble the following::

> python
Python 2.7.6 (default, Jun 22 2015, 17:58:13)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>>

Tapez exit() pour sortir de l’interpréte Python.

Si vous obtenez une erreur , soyez sur que l’execution de Python est dans votre PATH.

Si vous etes sur Windows suivez ses instructions

If you are on Linux locate the Python binary and add it to your PATH, edit your ~/.bashrc and add the following at the end of the file::

export PATH=$PATH:/path/to/the/python-binary

Redémarrez votre terminal pour rendre les changements efficaces.

Now check that you can invoke pip typing pip –version. The output should resemble the following::

pip 1.5.4 from /usr/lib/python2.7/dist-packages (python 2.7)

Si vous obtenez une erreur, soyez sur que le pip executable est dans votre PATH.

Installez Sphinx

To install Sphinx on your machine, type the following in your terminal::

pip install Sphinx

Note

Si vous etes sur Linux , vous pourrez avoir besoin de préfixer les commandes avec sudo.

Now test your installation::

> sphinx-build --version
Sphinx (sphinx-build) 1.3.1

Pour un guide d’ installation plus détaillé , faites référence à ce document

Vérifiez la source de la documentation.

Vu que l’accés de l’écriture du dépot du document principal est limité , vous voulez peut être travailler avec votre fork. Login Github avec votre compte , naviguez dans le dépot de la documentation et cliquez sur fork . Vous serez redirigés sur votre propre fork de la documentation.

Soyez sur d’avoir déjà configuré votre Git username et adresse email

Now clone your repository locally::

git clone https://github.com/your-user/doc-geonode.git

Où your-user est votre username sur GitHub.

Maintenant , faites les changements que vous voulez à la documentation.

Construisez la documentation.

To build the documentation locally on your machine, open the terminal and move to the project root directory, then run the following::

make html

La version html du document sera construite dans le sous-dossier build. Utilisez votre web browser favori pour ouvrir l’index filed appelé index.html.

Quand vous faites des changements à la documentation , reconstruisez la périodiquement pour être sur que le résultat final reflette ce que vous attendiez.

Editez la documentation.

La documentation est gardée dans un format de texte restructuré . Pour une rapide référence , référez vous à cela document. Pour un document plus précis , faites référence à cette documentation officielle.

Référez vos changements au dépot principal.

Vous avez terminés les modifications de la documentation et vous êtes prêt à soumettre vos changements . Si vous êtes nouveau à Git , assurez vous d’en avoir saisi les bases avant d’aller plus loin. Il y a plusieurs sources d’informations online , vous pouvez Google cela ou lire ceci <https://git-scm.com/book/en/v2/Getting-Started-Git-Basics> _ introduction.

Exécute git status et git diff pour revoir les changements que vous avez fait et reconstruisez la documentation localement comme expliqué ci-dessus.

Add the files with the changes you want to submit to the staging area:

git add path/to/file

And commit the changes:

git commit

Then push them to your personal GitHub repository:

git push origin master

Ouvrez votre browser favori and naviguez sur votre dépot GitHub. Vous serez capable de voir le long votre dernièr commit avec un message déclarant que votre branch est devant le dépot principal. Cliquez sur le bouton ‘pull request’ pour faire une pull request contre le dépot officiel de la documentation.

Créez une pull request avec une brève description de ce que vous avez fait. La pull request revue et eventuellement fusionné dans le dépot de la documentation officielle.