Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- DVC
- Pisarz techniczny:
- imhardikj
- Nazwa projektu:
- Wdrożenie przewodników po sekcji „Instrukcje” i aktualizowanie dokumentacji DVC 1.0
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jednym z celów tego projektu jest wdrożenie sekcji „Instrukcje”, która zawiera szczegółowe informacje na najczęściej zadawane pytania dotyczące DVC. Następnym celem jest zaktualizowanie dokumentacji zgodnie z najnowszą wersją DVC 1.x. W porównaniu z poprzednimi wersjami wprowadzono znaczne zmiany, dlatego zaktualizowane dokumenty muszą zostać zaktualizowane do najnowszej wersji. Po jego zakończeniu następne zadania będą oparte na priorytetach DVC w okresie pisania tekstów.
Cele projektu:
1) Proponowana sekcja „Jak to zrobić”: – Jak „cofnąć”, „dodanie DVC” (Jak cofać błędy). – Jak dodać brakującą zależność do istniejącego potoku. – Jak korzystać z DVC, gdy dane są przechowywane na dysku zewnętrznym (zewnętrzny przewodnik po zarządzaniu danymi).
Oto niektóre pomysły związane z problemem GitHuba (github.com/iterative/dvc.org/issue/899), które można uwzględnić w tej sekcji. Wymaga to również przeniesienia części istniejącej dokumentacji (np. „Uruchamianie DVC w systemie Windows”) do tej sekcji. Jeśli cel instrukcji nie pasuje do tej sekcji, możesz go zaktualizować w dokumentacji polecenia (lub w odpowiedniej dokumentacji), podając przykład. Tę sekcję można rozwinąć tak, aby zawierała więcej instrukcji, gdy napotkam je na kanałach społeczności.
2) Inną ważną częścią tego projektu jest zaktualizowanie dokumentacji po opublikowaniu DVC 1.0 (dvc.org/blog/dvc-1-0-release) oraz innych odpowiednich aktualizacji, które mogą zostać opublikowane do września. Dokumenty (wszystkie odniesienia do poleceń itp.) powinny zostać zaktualizowane zgodnie z tymi zmianami, z których część jest opisana w tym wielkim problemie (github.com/iterative/dvc.org/issue/1255).
3) Mogę też zająć się aktualizacją samouczków i scenariuszy Katacoda (github.com/iterative/dvc.org/issue/670).
4) Jeśli sekcja instrukcji i scenariusze Katacoda zostaną zakończone przed zakończeniem okresu pisania, reszta pracy będzie przebiegać zgodnie z priorytetami DVC w tym czasie i innymi zadaniami.
Nakłady czasowe:
W trakcie pisania będę mieć standardową studia. Nie mam żadnych innych zobowiązań oprócz tego. W trakcie całego projektu mogę poświęcić 30 godzin tygodniowo.