Projet DVC

Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.

Résumé du projet

Organisation Open Source:
DVC
Rédacteur technique:
imhardikj
Nom du projet:
Implémentation des guides de la section "Comment faire" et mise à jour des documents DVC 1.0
Durée du projet:
Durée standard (3 mois)

Project description

L'un des objectifs de ce projet est d'implémenter la section "Guide" qui répond en détail aux questions fréquentes liées au 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. Par conséquent, les documents doivent être mis à jour avec la dernière version. Une fois cette étape terminée, les tâches suivantes seront basées sur les priorités du DVC pendant la période d'écriture.

Objectifs du projet:

1) Quelques exemples pour la section "Procédure" proposée : - Comment "annuler" "dvc add" (comment annuler les erreurs) - Comment ajouter une dépendance manquante à un pipeline existant. - Comment utiliser DVC lorsque les données sont stockées sur un disque externe (guide de gestion des données externes).

Voici quelques-unes des 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") vers cette section. Si un objectif d'instruction ne convient pas à cette section, il peut être mis à jour dans la documentation de référence des commandes (ou dans la documentation appropriée) avec un exemple. Vous pouvez développer cette section pour y inclure d'autres problèmes pratiques chaque fois que je les rencontre sur les chaînes de la communauté.

2) L'autre partie importante de ce projet consiste à mettre à jour la documentation maintenant que DVC 1.0 est disponible (dvc.org/blog/dvc-1-0-release), et conformément aux autres mises à jour pertinentes susceptibles d'être publiées en septembre. Les documents (toutes les références de commande, etc.) sont censés être mis à jour en fonction de ces modifications, dont certaines sont mentionnées dans cet énorme 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 "Guide pratique", mise à jour des documents DVC 1.0 et des scénarios Katacoda est terminée avant la fin de la période d'écriture, le reste du travail se basera sur les priorités DVC pendant cette période et sur d'autres tâches diverses.

Engagement de temps:

Je serai en cours pendant la période d'écriture. Je n'ai aucun autre engagement. Je pourrai consacrer 30 heures par semaine pendant toute la durée du projet.