Pedro-Juan Ferrer edited this page Feb 27, 2014 · 16 revisions

El objetivo de Geotalleres es facilitar la preparación y mejorar la calidad de los talleres en castellano sobre tecnología de uso frecuente en el ámbito geoespacial. Para ello se pone a disposición este repositorio con materiales teóricos y prácticos en reStructuredText.

reStructuredText es un lenguaje de marcado para la creación de documentación. Para más información ver aquí: http://docutils.sourceforge.net/rst.html

Materiales

La estructura de los contenidos se compone de un fichero index.rst que enlaza todos los materiales::

/
|- material1
|  material2
|  ...
|  materialn
|  
\- index.rst

Los materiales pueden contener cualquier tipo de información: Introducción a servicios web, introducción a linux, análisis con PostGIS, carga de mosaicos temporales en GeoServer, etc.

Pero es importante que un mismo material hable sólo de un tema concreto y no toque secuencialmente más de uno. De esta manera se facilita su reutilización en distintos contextos. Más información: Cómo monto mi curso.

Autoría, copyright, licencias, ...

Obviamente habrá materiales de distintos autores, licencias y copyright por lo que es imprescindible acreditar estos justo después del título principal::

Cocochas con GeoServer
======================

.. note::

	================  ================================================
	Fecha              Autores
	================  ================================================             
	1 Diciembre 2012    * Oscar Fonts (oscar.fonts@geomati.co) 
	================  ================================================	

	©2013 FAO Forestry 
	
	Excepto donde quede reflejado de otra manera, la presente documentación
	se halla bajo licencia : Creative Commons (Creative Commons - Attribution
	- Share Alike: http://creativecommons.org/licenses/by-sa/3.0/deed.es)

¿Cómo monto mi curso?

Por defecto el fichero index.rst que se encuentra en la raíz enlaza todos los materiales. Obviamente, con frecuencia no se pretende obtener material para un curso que toca todos los temas. Para ello hay que modificar el fichero index.rst y dejar sólo los materiales relevantes. Por ejemplo, para generar un curso de GeoServer que incluya una introducción a Linux podría dejarse el index.rst así::

Curso de GeoServer
======================

Contenidos:

.. toctree::
   :maxdepth: 3

   linux/linux
   geoserver-intro/geoserver_intro
   geoserver-vector/geoserver_vector
   geoserver-raster/geoserver_raster

Desde un punto de vista práctico, el primer paso para montar el curso es descargarse el repositorio de materiales::

git clone --recursive https://github.com/geotalleres/geotalleres.git

El parámetro --recursive nos permite descargar también los materiales que no se encuentran físicamente en el repositorio de geotalleres sino que son enlazados como submódulos (caso del taller de MapProxy).

A continuación se edita el fichero index.rst para dejar sólo los materiales que nos interesan. Y por último, basta con ejecutar make clean html o make clean latexpdf para generar la documentación.

Nota que cada capítulo incluye una nota con la autoría con lo que el problema de referenciar material de terceros está solucionado automáticamente. Incluir el copyright en cada tema de tu curso puede resultar un poco feo, pero es necesario recompensar el trabajo de la gente que puso su trabajo a tu disposición.

Creación de nuevo contenido directamente en el repositorio de geotalleres

  1. Crea un nuevo directorio al mismo nivel que index.rst
  2. Modifica index.rst para referenciarlo
  3. ¡No te olvides de poner la nota referenciando la autoría! Ver Autoría, copyright, licencias, ...

Para hacer los materiales más fácilmente reutilizables es conveniente que sean muy concretos. Por ejemplo, si tenemos un curso de GeoServer con dos temas sobre cómo añadir capas y como configurar usuarios, es mucho mejor añadir los dos temas en directorios separados e incluyendo dos entradas en el index.rst ya que así alguien puede reutilizar sólo una parte del curso de GeoServer.

Nota: Si has hecho un fork del proyecto, cuando tengas el contenido listo haz un pull request.

Creación de nuevo contenido usando un submódulo

Abre un ticket en el proyecto indicando:

  • repositorio al que hay que apuntar el submódulo (¡recordar añadirlo por http!)
  • ruta del documento o documentos raíz del contenido (lo que hay que añadir al index.rst
  • si has usado substituciones, indica qué hay que añadir al archivo conf.py

Nota: ¡No te olvides de poner la nota referenciando la autoría! Ver Autoría, copyright, licencias, ...

Modificaciones

Siempre preguntar al autor y ante cualquier duda utiliza la lista de correo o abre un ticket.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.