Cómo contribuir a la documentación de GeoNode¶
Si deseas agregar o cambiar algo en la documentación de GeoNode, puedes hacerlo. La documentación siempre necesita mejoras, ya que el desarrollo del software avanza bastante rápido.
Para contribuir a la documentación de GeoNode debes:
Lea las pautas de estilo de GeoServer
Crea una cuenta en GitHub
Bifurcar el repositorio GeoNode
Editar los archivos
Enviar solicitudes de extracción
En general, todo esto se puede hacer desde el navegador, no es necesario descargar nada. Sin embargo, si necesitas agregar imágenes o planeas hacer cambios más grandes, se recomienda trabajar de forma local.
Pautas de estilo¶
Si bien no tenemos reglas estrictas para escribir documentos, te recomendamos leer las Pautas de estilo de GeoServer antes de comenzar a escribir: https://docs.geoserver.org/latest/en/docguide/style.html
Crea una cuenta en GitHub¶
El primer paso es crear una cuenta en GitHub. Solo tienes que ir a Github, buscar un nombre de usuario que te convenga, introducir tu correo electrónico y una contraseña y pulsar Registrarse en GitHub. Una vez que hayas iniciado sesión, visita el repositorio geonode_documentation https://github.com/geonode/documentation.
Bifurcar el repositorio de documentación¶
Para realizar cambios, primero debes bifurcar el repositorio. En la parte superior derecha del sitio web, encontrarás un botón llamado «fork» para hacerlo.
Si deseas leer más sobre la bifurcación, visite la documentación oficial de GitHub: https://help.github.com/articles/fork-a-repo.
Editar archivos en Github¶
Para realizar cambios menores, puedes utilizar el sitio web de GitHub. Navega en tu navegador hasta el repositorio bifurcado. Para realizar cambios en los archivos, navega hasta el archivo en cuestión y presiona el botón editar en la parte superior derecha.
Nota
La documentación está escrita en reStructeredText, un lenguaje de marcado ligero. Para aprender a usarlo, consulte: https://docutils.sourceforge.net/docs/user/rst/quickref.html.
Al hacer clic en el botón vista previa podrás ver cómo se verán sus cambios. Para guardar los cambios, haz clic en Confirmar cambios en la parte inferior del sitio.
Para solicitar a los encargados de la documentación que integren tus cambios, es necesario crear una Pull Request. Por lo tanto, utiliza el botón new pull request para iniciar el proceso. Encuentra más información sobre las solicitudes de incorporación de cambios en la documentación oficial de GitHub: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests .
Editar archivos localmente¶
Si planeas realizar cambios más importantes en la estructura de la documentación, es recomendable realizar los cambios de forma local. Además, si bien puedes trabajar en tu rama maestra, se recomienda crear una rama dedicada a los cambios.
Comienza navegando a una carpeta donde deseas mantener tu repositorio localmente e instala las dependencias necesarias:
$ cd /opt
$ git clone https://github.com/your_documentation_repository
$ git remote add upstream https://github.com/geonode/documentation
# add the GeoNode documentation repository as "upstream" source
$ cd your_documentation_repository
$ git fetch upstream;
# get last commits from upstream
$ git merge upstream/master master
# merge the upstream with your fork
# if you like, you can also use 'git pull', which is nothing else than fetching and merging in one step
$ git push
# update your repository at GitHub (origin)
¡Tu repositorio ya debería estar actualizado! Para obtener más información sobre esos comandos, visita https://git-scm.com/docs. Instalemos las dependencias:
$ pip install virtualenv
$ virtualenv docs_env
$ source docs_env/bin/activate
$ pip install sphinx sphinx_rtd_theme sphinx-autobuild
Ahora puedes iniciar el servidor de desarrollo de Sphinx que servirá y recargará en vivo sus documentos en https://localhost:8000
$ sphinx-autobuild . _build
Cuando termine, crea una compilación con el siguiente comando:
$ make html
# for a last check you can open the index.html in _build subdirectory
Crear una solicitud de extracción¶
Al igual que con la edición directa de archivos en tu navegador, deberás crear una solicitud de extracción para solicitar la integración de tus cambios en el repositorio principal.
$ git status
# will list all changed files
$ git add ...
# add the files of interest
$ git commit -m 'Fixes #1234 Updated docs for ...'
# choose a meaningful commit message
$ git push <branch>
Después de ejecutar estos comandos, navega con tu navegador hasta tu repositorio de GitHub y crea una solicitud de extracción como se explicó anteriormente.