Meta-manual

Este es un mini-manual para explicar cómo puedes ayudar a desarrollar el manual colaborativo de introducción a OSM que estamos desarrollando desde Mapeado Colaborativo.

¿Por qué gitbook?

(Desarrollar)

• Gratuito y sin necesidad de tener grandes conocimientos técnicos
• Permite la colaboración
• Tenemos una versión online del libro con índice y buscador
• Permite exportar a otros formatos (PDF, mobi...)
• Integración con github: en realidad lo estamos usando casi como interfaz (con esteroides) de git: estamos usando git, archivos de markdown (y algún json e imágenes) y github para crearlo.
• Podemos usar herramientas propias para editarlo

Requisitos previos para poder colaborar

Para poder colaborar en cualquiera de sus maneras es necesario tener una cuenta en gitbook. La buena noticia es que es gratuito y podemos usar una cuenta ad-hoc o usar la cuenta de twitter, facebook, google... o -la opción recomendada- github. Utilizar una cuenta de github es la que más opciones de colaboración nos va a permitir, además de que podremos usarla para colaborar en otros proyectos de Mapeado Colaborativo.

Formas de colaborar

Comentarios

Esta opción es la más sencilla y está pensada para pequeños cambios. Los comentarios son pequeñas anotaciones al margen que a su vez se muestran en la página de discusiones.

1. En la vista de lectura del libro, hacer clic en el icono + que aparece en el lado derecho cuando pasamos con el cursor por encima del párrafo que queremos comentar.

Desarrollar algún capítulo

Podemos desarrollar algún capítulo existente para mejorarlo o crear una receta nueva. Podemos trabajar solos o en grupo.

Identificar el capítulo por desarrollar

Leer el índice de contenidos del manual e identificar aquél o aquellos que queráis desarrollar, ya sea porque sabéis mucho del tema o porque queréis aprender al respecto. (ver manual colaborativo de introducción a OSM). Podéis informar de vuestra intención en la página de discusión del manual o empezar a desarrollar directamente.

Editar desde gitbook

1. Crear una cuenta de usuario para acceder a gitbook (podéis usar una cuenta ad-hoc o usar vuestra cuenta de twitter, facebook, google... o -la opción recomendada- github.

2. Pedir permisos de edición para el libro, ya sea

   1. En la página de discusión del manual
   2. En la lista de correo del grupo

3. Opción A: Usar el editor integrado de gitbook

   1. Visitar el libro y hacer clic en "Editar".
   2. (Altamente recomendable) Crear una nueva versión:
      1. hacer clic en el enlace +Create a new version de la parte superior derecha de la barra
      2. darle un nombre relevante que describa lo que vais a hacer (ej: receta-accesibilidad, o "unirse a la comunidad")
      3. Editar y guardar cambios tantas veces como sea necesario
      4. Una vez deis por terminado vuestro trabajo, informar en la página de discusión del manual de que ya habéis terminado para que algún administrador integre vuestro trabajo en la rama master y se vea públicamente (da igual que no esté perfectamente terminado, podemos

4. Opción B: usando el programa de edición de gitbook para edición offline (requiere conexión para descargar cambios y luego subirlos):

   1. Acceder a https://www.gitbook.com/editor

   2. Descargar e instalar el programa

   3. Logearse con los datos de la cuenta de usuario de gitbook

   4. (La primera vez)

      1. Acceder a la pestaña superior derecha llamada gitbook.com

      2. Seleccionar el manual de introducción a OSM

      3. Descargarlo

1. Acceder a la pestaña biblioteca local

2. Seleccionar el manual

3. Editarlo y seguir las instrucciones de la opción A

Editar para amantes de git (fork + pull request)

1. Clonar repo git clone [email protected]:mapcolabora/manual-osm.git
2. Hacer fork
3. Crear pull request
4. Esperar a que algún administrador haga la integración en la rama master del repositorio original