Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- DVC
- Pisarz techniczny:
- imhardikj
- Nazwa projektu:
- Wdrażanie sekcji „Instrukcje” i aktualizowanie dokumentów DVC 1.0
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jednym z celów tego projektu jest wdrożenie sekcji „Jak to zrobić”, która szczegółowo odpowiada na częste pytania dotyczące DVC. Następnym celem jest zaktualizowanie dokumentacji zgodnie z najnowszą wersją DVC 1.x. W porównaniu z poprzednimi wersjami wprowadzono w nich istotne zmiany, dlatego należy zaktualizować dokumenty do najnowszej wersji. Kolejne zadania będą oparte na priorytetach DVC na czas pisania wiadomości.
Cele projektu:
1) Kilka przykładów do proponowanej sekcji „Jak to zrobić”: - Jak „cofnąć” polecenie 'dvc add' (jak cofnąć błędy). – Jak dodać brakujące zależności do istniejącego procesu. – Jak korzystać z DVC, gdy dane są przechowywane na dysku zewnętrznym (przewodnik po zarządzaniu danymi zewnętrznymi).
Oto kilka pomysłów opartych na problemie na GitHub (github.com/iterative/dvc.org/issues/899), które można uwzględnić w tej sekcji. Wiąże się to też z przeniesieniem części istniejącej dokumentacji (np. „Uruchamianie DVC w systemie Windows”) do tej sekcji. Jeśli cel instruktażowy nie pasuje do tej sekcji, możesz go zaktualizować w opisie polecenia (lub odpowiedniej dokumentacji) za pomocą przykładu. Za każdym razem, gdy natrafię na problemy na kanałach społecznościowych, tę sekcję można rozszerzyć, dodając więcej instrukcji.
2) Drugim ważnym elementem tego projektu jest zaktualizowanie dokumentacji, ponieważ została wydana wersja DVC 1.0 (dvc.org/blog/dvc-1-0-release) oraz inne istotne aktualizacje, które mogą zostać opublikowane do września. Dokumenty (wszystkie odwołania do poleceń itp.) powinny zostać zaktualizowane zgodnie z tymi zmianami, które są wymienione w tym problemie (github.com/iterative/dvc.org/issues/1255).
3) Mogę też pracować nad aktualizowaniem samouczków i scenariuszy Katacoda (github.com/iterative/dvc.org/issues/670).
4) Jeśli sekcja „Jak to zrobić”, aktualizacja dokumentów DVC 1.0 i scenariusze Katacoda zostaną ukończone przed końcem okresu pisania, pozostała część pracy będzie zależeć od priorytetów DVC w tym czasie i innych zadań.
Zaangażowanie czasowe:
W czasie pisania będę mieć normalne zajęcia. Poza tym nie mam żadnych innych zobowiązań. Przez cały czas trwania projektu będę mógł poświęcić 30 godzin tygodniowo.