Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- DVC
- Rédacteur technique:
- imhardikj
- Nom du projet:
- Implémenter les guides de la section "How To" et mettre à jour la documentation DVC 1.0
- Durée du projet:
- Durée standard (3 mois)
Project description
L'un des objectifs de ce projet est de mettre en œuvre la section "How To" (Comment faire) qui répond en détail aux questions fréquentes concernant DVC. L'objectif suivant est de mettre à jour la documentation conformément à la dernière version de DVC 1.x. Des modifications importantes ont été apportées par rapport aux versions précédentes. Vous devez donc installer la dernière version des documents. Une fois l'opération terminée, les tâches suivantes seront basées sur les priorités de DVC pendant la période de rédaction.
Objectifs du projet:
1) Voici quelques exemples pour la section "Procédure" proposée : - Comment "annuler" l'opération "dvc add" (pour annuler les erreurs). - Ajouter une dépendance manquante à un pipeline existant - Utiliser DVC lorsque les données sont stockées sur un disque externe (guide externe de gestion des données)
Voici quelques idées basées sur le problème GitHub (github.com/iterative/dvc.org/issues/899) qui peuvent être incluses dans cette section. Cela implique également de déplacer une partie de la documentation existante (par exemple, « Exécuter DVC sous Windows ») dans cette section. Si un objectif du guide ne convient pas à cette section, vous pouvez le mettre à jour dans la documentation de référence de la commande (ou dans la documentation pertinente) avec un exemple. Vous pouvez développer cette section pour inclure d'autres questions pratiques chaque fois que je les rencontre sur une chaîne de la communauté.
2) L'autre partie importante du projet consiste à mettre à jour la documentation suite à la publication de DVC 1.0 (dvc.org/blog/dvc-1-0-release), ainsi qu'aux autres mises à jour pertinentes susceptibles d'être publiées avant septembre. Les documents (toutes les références aux commandes, etc.) sont censés être mis à jour en fonction de ces modifications, dont certaines sont mentionnées dans ce problème (github.com/iterative/dvc.org/issues/1255).
3) Je peux également travailler sur la mise à jour des tutoriels et des scénarios Katacoda (github.com/iterative/dvc.org/issues/670).
4) Si la section Tutoriel, la mise à jour des documents DVC 1.0 et les scénarios Katacoda sont terminés avant la fin de la période de rédaction, le reste du travail sera basé sur les priorités DVC pendant cette période et d'autres tâches diverses.
Engagement en temps:
J'aurai mon université habituelle pendant la période d'écriture. Je n'ai d'autre engagement que celui-ci. Je pourrai consacrer 30 heures par semaine pendant toute la durée du projet.