Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- DVC
- Redator técnico:
- imhardikj
- Nome do projeto:
- Implementação de guias de seção "Instruções" e atualização dos documentos do DVC 1.0
- Duração do projeto:
- Duração padrão (três meses)
Project description
Um dos objetivos deste projeto é implementar a seção "Como fazer", que aborda em detalhes as perguntas comuns relacionadas ao DVC. O próximo objetivo é atualizar a documentação de acordo com a versão mais recente do DVC 1.x. Como há mudanças significativas em comparação com as versões anteriores, os documentos precisam ser atualizados para a versão mais recente. Depois disso, as próximas tarefas serão baseadas nas prioridades do DVC durante o período de gravação.
Metas do projeto:
1) Alguns exemplos para a seção "Como fazer" proposta: - Como ""desfazer"" 'dvc add' (Como desfazer erros). - Como adicionar uma dependência ausente a um pipeline. - Como usar o DVC quando os dados são armazenados em um drive externo (guia de gerenciamento de dados externos).
Estas são algumas das ideias baseadas no problema do GitHub (github.com/iterative/dvc.org/issues/899) que podem ser incluídas nesta seção. Isso também envolve a mudança de algumas das documentações existentes (por exemplo, "Executar o DVC no Windows") para esta seção. Se uma meta de instrução não for adequada para esta seção, ela poderá ser atualizada na referência de comando (ou na documentação relevante) com um exemplo. Essa seção pode ser expandida para incluir mais problemas de instruções sempre que eu encontrar em canais da comunidade.
2) A outra parte significativa deste projeto é atualizar a documentação agora que o DVC 1.0 foi lançado (dvc.org/blog/dvc-1-0-release) e de acordo com outras atualizações relevantes que podem ser lançadas até setembro. Os documentos (todas as referências de comando etc.) precisam ser atualizados de acordo com essas mudanças, algumas das quais são mencionadas neste problema épico (github.com/iterative/dvc.org/issues/1255).
3) Também posso trabalhar na atualização de tutoriais e cenários da Katacoda (github.com/iterative/dvc.org/issues/670).
4) Se a seção "Como fazer", a atualização dos documentos do DVC 1.0 e os cenários do Katacoda forem concluídos antes do fim do período de escrita, o restante do trabalho será baseado nas prioridades do DVC durante esse período e em outras tarefas diversas.
Compromisso com o tempo:
Estarei com minha faculdade regular durante o período de redação. Não tenho outros compromissos, exceto este. Vou poder dedicar 30 horas por semana durante toda a duração do projeto.