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:
- DVC
- Escritor técnico:
- imhardikj
- Nombre del proyecto:
- Implementación de guías de la sección “Instructivos” y actualiza los 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 «Instructivo» que aborde en detalle las preguntas frecuentes relacionadas con los DVC. El siguiente objetivo es actualizar la documentación según la última versión de DVC 1.x. Hay cambios significativos en comparación con las versiones anteriores y, por lo tanto, los documentos deben actualizarse a la versión más reciente. Una vez completada, 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 "Instructivo" propuesta: - Cómo"deshacer" "agregar dvc" (cómo deshacer errores). - Cómo agregar una dependencia faltante a una canalización existente. - Cómo usar el DVC cuando los datos se almacenan en una unidad externa (Guía de administración de datos externos)
Estas son algunas de las ideas basadas en el problema de GitHub (github.com/iterative/dvc.org/issues/899) que puedes incluir en esta sección. Esto también implica reubicar parte de la documentación existente (por ejemplo, “Cómo ejecutar DVC en Windows”) a esta sección. Si un objetivo de instructivo no es adecuado para esta sección, se puede actualizar en la referencia de 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 otras actualizaciones relevantes que podrían publicarse antes de 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 este problema épico (github.com/iterative/dvc.org/issues/1255).
3) También puedo trabajar en la actualización de instructivos y situaciones de Katacoda (github.com/iterative/dvc.org/issues/670).
4) Si la sección de instructivos, la actualización de los documentos DVC 1.0 y los casos de Katacoda terminan antes de que finalice el período de redacción, el resto del trabajo se basará en las prioridades del DVC durante ese tiempo y otras tareas misceláneas.
Compromiso de tiempo:
Tendré mi universidad habitual durante el período de redacción. No tengo ningún otro compromiso, excepto este. Podré dedicar 30 horas a la semana durante toda la duración del proyecto.