Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Open Source Geospatial Foundation
- Escritor 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 mantenerlos actualizados, precisos y relevantes.
- Crea una plantilla para garantizar la coherencia en todos los documentos y para futuras guías de inicio rápido que se agreguen.
Público
- Ya están disponibles los usuarios nuevos de OSGeo
- Escritores de guías de inicio rápido en vivo de OSGeo
Entrega
- Wiki
Esto es lo que creo que hay que hacer:
- Ejecuta las 50 guías de inicio rápido existentes de OSGeo
- Lenguaje de marcado con ediciones Enviar para su revisión
- Implementar la revisión o los comentarios
- Crear una plantilla de inicio rápido para implementar la coherencia en el futuro
- Actualiza el campo "Cómo realizar un procedimiento de inicio rápido".
- Agrega apps nuevas a OSGeoLive; necesitan guías de inicio rápido.
Lo que te propongo hacer:
Revisa 50 guías de inicio rápido existentes de OSGeo Live y marca con ediciones; usa 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 el registro (Herramienta de seguimiento de errores)
Proporciona un informe en el que se resuma el resultado. Por ejemplo, el porcentaje de las 50 que requieren poco, medio o mucho trabajo.
Crea una plantilla de inicio rápido para implementar la coherencia en el futuro.
Actualiza la página “Cómo documentar el archivo de inicio rápido”.
Qué tendrás al final del SoD:
- 50 tickets de documentación en seguimiento, con guías de inicio rápido marcadas según la plantilla de inicio rápido acordada
- Un resumen del estado actual de las guías de inicio rápido de OSGeo y cuánto trabajo se requiere para actualizarlas.
- Una plantilla de inicio rápido actualizada coherente con la plantilla de la guía de entrenamiento.
- Un proceso de documentación de la guía de inicio rápido actualizado.
Por dónde empezar:
- Observa la hoja de cálculo OSGeo-Live Packages para ver qué paquetes cambiaron entre versiones.
- Consulta 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 he hecho:
- Se configuró mi VM y se instaló OSGeoLive.
- Bifurcó el repositorio OSGeoLive-Doc
- Obtuvo acceso a Trace y revisó algunos tickets de documentos existentes. El ticket n.o 1382 parece relevante: https://trac.osgeo.org/osgeolive/ticket/1382
- Participé en debates sobre la lista de distribución.
- Tuve algunos chats de video informales.