Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- DVC
- Redator técnico:
- imhardikj
- Nome do projeto:
- Como implementar os guias da seção "Instruções" e atualizar os documentos do DVC 1.0
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Um dos objetivos do projeto é implementar a seção de instruções que aborda em detalhes as dúvidas comuns relacionadas a DVC. O próximo objetivo é atualizar a documentação de acordo com a versão mais recente do DVC 1.x. Há mudanças significativas em comparação com versões anteriores, e os documentos precisam ser atualizados para a versão mais recente. Depois que isso for concluído, as próximas tarefas serão baseadas nas prioridades do DVC durante o período de redação.
Metas do projeto:
1) Alguns exemplos para a seção de instruções proposta: - Como ""desfazer"" 'dvc add' (como desfazer erros). - Como adicionar uma dependência ausente a um pipeline atual. - Como usar o DVC quando os dados estiverem armazenados em uma unidade externa (guia de gerenciamento de dados externos).
Essas são algumas 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 realocar parte da documentação atual (por exemplo, "Como executar DVC no Windows") para esta seção. Se uma meta de instruções 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 com instruções sempre que eu os encontrar nos canais da comunidade.
2) A outra parte importante desse 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.) devem ser atualizados de acordo com essas mudanças, e algumas delas 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 do Katacoda (github.com/iterative/dvc.org/issues/670).
4) Se a seção de instruções, atualizar documentos do DVC 1.0 e os cenários de Katacoda forem concluídos antes do final do período de redação, o restante do trabalho será baseado nas prioridades do DVC durante esse período e em outras tarefas diversas.
Compromisso de tempo:
Terei minha faculdade regular durante o período de escrita. Não tenho nenhum outro compromisso além deste. Poderei dedicar 30 horas por semana durante toda a duração do projeto.