Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- DVC
- Redattore tecnico:
- imhardikj
- Nome progetto:
- Implementazione delle guide della sezione "Istruzioni" e aggiornamento della documentazione di DVC 1.0
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Uno degli obiettivi di questo progetto è implementare la sezione "Istruzioni" che risponde in dettaglio alle domande più comuni relative al DVC. Il prossimo obiettivo è aggiornare la documentazione in base all'ultima release di DVC 1.x. Esistono modifiche significative rispetto alle release precedenti e, pertanto, le documentazioni devono essere aggiornate alla versione più recente. Al termine, le attività successive si baseranno sulle priorità del DVC durante il periodo di scrittura.
Obiettivi del progetto:
1) Alcuni esempi per la sezione "Istruzioni" proposta: - Come "annullare" "dvc add" (come annullare gli errori). - Come aggiungere una dipendenza mancante a una pipeline esistente. - Come utilizzare DVC quando i dati sono archiviati su un'unità esterna (guida alla gestione dei dati esterni).
Queste sono alcune delle idee basate sul problema di GitHub (github.com/iterative/dvc.org/issues/899) che possono essere incluse in questa sezione. Ciò comporta anche il trasferimento della documentazione esistente (ad esempio, "Esecuzione di DVC su Windows") in questa sezione. Se un obiettivo relativo alle procedure non è adatto a questa sezione, può essere aggiornato nel riferimento ai comandi (o nella documentazione pertinente) con un esempio. Questa sezione può essere ampliata per includere altri problemi relativi alle procedure quando li riscontro sui canali della community.
2) L'altra parte significativa di questo progetto è aggiornare la documentazione ora che DVC 1.0 è stato rilasciato (dvc.org/blog/dvc-1-0-release) e in base ad altri aggiornamenti pertinenti che potrebbero essere rilasciati entro settembre. I documenti (tutti i riferimenti ai comandi e così via) dovrebbero essere aggiornati in base a queste modifiche, alcune delle quali sono menzionate in questo epico numero (github.com/iterative/dvc.org/issues/1255).
3) Posso anche lavorare all'aggiornamento dei tutorial e degli scenari Katacoda (github.com/iterative/dvc.org/issues/670).
4) Se la sezione How-to, l'aggiornamento della documentazione di DVC 1.0 e gli scenari Katacoda vengono completati prima della fine del periodo di scrittura, il resto del lavoro si baserà sulle priorità di DVC durante questo periodo e su altre attività varie.
Impegno in termini di tempo:
Durante il periodo di stesura seguirò regolarmente l'università. Non ho altri impegni oltre a questo. Potrò impegnarmi per 30 ore alla settimana per tutta la durata del progetto.