En esta página, se incluyen 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:
- DVC
- Redactor técnico:
- imhardikj
- Nombre del proyecto:
- Implementación de guías de la sección "Instructivos" y actualización de documentos de DVC 1.0
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Uno de los objetivos de este proyecto es implementar la sección “Instructivos” en la que se abordan en detalle las preguntas frecuentes relacionadas con el DVC. El siguiente objetivo es actualizar la documentación según la versión más reciente de DVC 1.x. Hay cambios significativos en comparación con las versiones anteriores y, por lo tanto, se deben actualizar los documentos a la versión más reciente. Una vez que se complete este proceso, las siguientes tareas se basarán en las prioridades del DVC durante el período de redacción.
Objetivos del proyecto:
1) Algunos ejemplos para la sección “Instructivos” propuesta: - Cómo “deshacer” “dvc add” (cómo deshacer errores). - Cómo agregar una dependencia faltante a una canalización existente - Cómo usar DVC cuando los datos se almacenan en una unidad externa (guía de administración de datos externos)
Estas son algunas ideas basadas en el problema de GitHub (github.com/iterative/dvc.org/issues/899) que se pueden incluir en esta sección. Esto también implica reubicar parte de la documentación existente (por ejemplo, "Cómo ejecutar DVC en Windows") en esta sección. Si un objetivo de instructivos no es adecuado para esta sección, se puede actualizar en la referencia del comando (o en la documentación relevante) con un ejemplo. Esta sección se puede expandir para incluir más instructivos cada vez que los encuentre en los canales de la comunidad.
2) La otra parte importante de este proyecto es actualizar la documentación ahora que se lanzó DVC 1.0 (dvc.org/blog/dvc-1-0-release) y según otras actualizaciones relevantes que se puedan lanzar en septiembre. Se supone que los documentos (todas las referencias de comandos, etc.) se deben actualizar de acuerdo con estos cambios, algunos de los cuales se mencionan en esta edición épica (github.com/iterative/dvc.org/issues/1255).
3) También puedo trabajar en la actualización de los instructivos y las situaciones de Katacoda (github.com/iterative/dvc.org/issues/670).
4) Si la sección de instructivos, la actualización de los documentos de DVC 1.0 y las situaciones de Katacoda terminan antes de que finalice el período de redacción, el resto del trabajo se basará en las prioridades de DVC durante ese tiempo y en otras tareas misceláneas.
Compromiso de tiempo:
Tendré mi universidad habitual durante el período de escritura. No tengo otros compromisos, excepto este. Podré dedicar 30 horas por semana durante toda la duración del proyecto.