Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Open Source Geospatial Foundation
- Redactor técnico:
- flicstar
- Nombre del proyecto:
- Revisa las guías de inicio rápido de OSGeoLive
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Objetivo
- Actualiza los documentos para que estén actualizados, sean precisos y relevantes.
- Crea una plantilla para garantizar la coherencia en todos los documentos y para las futuras guías de inicio rápido que se agreguen.
Público
- Usuarios nuevos de OSGeo en vivo
- Escritores de las nuevas guías de inicio rápido en vivo de OSGeo
Entrega
- Wiki
Esto es lo que creo que debemos hacer:
- Revisa las 50 guías de inicio rápido de OSGeo Live existentes
- Marcado con ediciones Enviar para revisión
- Implementa la revisión o los comentarios
- Crea una plantilla de guía de inicio rápido para implementar la coherencia en el futuro.
- Actualiza el procedimiento de Inicio rápido.
- Agrega apps nuevas a OSGeoLive. Necesitan guías de inicio rápido.
Mi propuesta es la siguiente:
Revisa las 50 guías de inicio rápido de OSGeo Live existentes y haz marcas de edición con estas páginas como referencia:
Nuevo: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Anterior: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Crear problemas de documentación en Tract (Herramienta de seguimiento de errores)
Proporciona un informe en el que se resuma el resultado. Por ejemplo, el porcentaje de los 50 que requieren trabajo mínimo, medio o mucho trabajo.
Crea una plantilla de inicio rápido para implementar la coherencia en el futuro.
Se actualizó la página "Cómo documentar el archivo de la guía de inicio rápido".
Esto es lo que tendrás al final de la SoD:
- 50 tickets de documentación en Trac, con guías de inicio rápido marcadas según la plantilla de guía de inicio rápido acordada
- Es una instantánea del estado actual de los instructivos rápidos de OSGeo Live y la cantidad de trabajo que se requiere para actualizarlos.
- Una plantilla de Guía de inicio rápido actualizada coherente con la plantilla de la Guía de capacitación.
- Un proceso actualizado de documentación de la guía de inicio rápido.
Por dónde comenzaré:
- Consulta la hoja de cálculo de paquetes de OSGeo-Live para ver qué paquetes cambiaron entre las versiones.
- Pregúntale a la lista de distribución de OSGEo Live si tienen sugerencias de guías de inicio rápido específicas para comenzar.
Lo que ya hice:
- Configuramos la VM y, luego, instalamos OSGeoLive.
- Se creó una bifurcación del repositorio de OSGeoLive-Doc.
- Obtuve acceso al seguimiento y revisaste algunos tickets de documentos existentes. El ticket #1382 parece relevante: https://trac.osgeo.org/osgeolive/ticket/1382
- Participar en debates de listas de distribución
- Tener algunos chats de video informales