Cómo contribuir a la documentación de GeoNode¶

Si desea agregar o cambiar algo en la documentación de GeoNode, puede 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 de GeoNode
Editar los archivos
Enviar solicitudes de extracción

Por lo general, todas estas cosas se pueden hacer desde su navegador, no necesitará descargar nada.Sin embargo, si necesita agregar imágenes o planificar cambios más importantes, se recomienda trabajar localmente.

Pautas de estilo¶

Si bien no tenemos reglas estrictas para escribir documentos, le recomendamos que lea 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.Simplemente vaya a Github, busque un nombre de usuario que se adapte a sus necesidades, ingrese su correo electrónico y una contraseña y presione Registrarse en GitHub.Después de haber iniciado sesión, visite 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á un botón llamado «fork» para hacerlo.

Si desea leer más sobre la bifurcación, visite los documentos oficiales de GitHub: https://help.github.com/articles/fork-a-repo.

Editar archivos en Github¶

Para cambios más pequeños, puede utilizar el sitio web de GitHub.Navegue su navegador hasta su repositorio bifurcado.Para realizar cambios en los archivos, navegue hasta el archivo en cuestión y presione 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 presionar el botón vista previa podrás ver cómo se verán tus cambios.Para guardar sus cambios, haga clic en Confirmar cambios en la parte inferior del sitio.

Para pedir a los mantenedores de la documentación que integren sus cambios, es necesaria la creación de una Solicitud de extracción.Por lo tanto, utilice el botón nueva solicitud de extracción para iniciar el proceso.Obtenga más información sobre las solicitudes de extracción 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 está planeando cambios mayores en la estructura de la documentación, es recomendable realizar los cambios localmente.Además, si bien puede trabajar en su rama maestra, se recomienda crear una rama dedicada para sus cambios.

Comience navegando a una carpeta donde desee mantener su repositorio localmente e instale 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 ahora debería estar actualizado!Para obtener más información sobre esos comandos, vaya a 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 puede iniciar el servidor de desarrollo sphinx que servirá y recargará en vivo sus documentos en https://localhost:8000

$ sphinx-autobuild . _build

Cuando termine, cree 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 su navegador, deberá crear una solicitud de extracción para solicitar la integración de sus 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, navegue en su navegador hasta su repositorio de GitHub y cree una solicitud de extracción como se explicó anteriormente.