Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- DVC
- Penulis teknis:
- imhardikj
- Nama proyek:
- Menerapkan panduan bagian "Petunjuk" dan memperbarui dokumen DVC 1.0
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Salah satu tujuan dari proyek ini adalah menerapkan bagian “Petunjuk” yang membahas secara mendetail pertanyaan umum terkait DVC. Tujuan berikutnya adalah memperbarui dokumentasi sesuai rilis DVC 1.x terbaru. Ada perubahan signifikan dibandingkan dengan rilis sebelumnya dan karenanya dokumen harus diperbarui ke versi terbaru. Setelah ini selesai, tugas berikutnya akan didasarkan pada prioritas DVC selama periode penulisan.
Tujuan proyek:
1) Beberapa contoh untuk bagian “Cara” yang diusulkan: - Cara ""mengurungkan" 'dvc add' (Cara mengurungkan kesalahan). - Cara menambahkan dependensi yang hilang ke pipeline yang ada. - Cara menggunakan DVC saat data disimpan di drive eksternal (Panduan pengelolaan data eksternal).
Ini adalah beberapa ide berdasarkan masalah GitHub (github.com/iterative/dvc.org/issues/899) yang dapat disertakan dalam bagian ini. Hal ini juga melibatkan pemindahan beberapa dokumentasi yang ada (misalnya, “Menjalankan DVC di Windows”) ke bagian ini. Jika sasaran petunjuk tidak cocok untuk bagian ini, sasaran tersebut dapat diperbarui di referensi perintah (atau dokumentasi yang relevan) dengan contoh. Bagian ini dapat diperluas untuk menyertakan lebih banyak masalah petunjuk setiap kali saya menemukannya di channel komunitas.
2) Bagian penting lainnya dari proyek ini adalah untuk memperbarui dokumentasi sekarang bahwa DVC 1.0 dirilis (dvc.org/blog/dvc-1-0-release), dan sesuai dengan pembaruan relevan lainnya yang mungkin dirilis pada bulan September. Dokumen (semua referensi perintah, dll.) seharusnya diperbarui sesuai dengan perubahan ini, beberapa di antaranya disebutkan dalam masalah epik ini (github.com/iterative/dvc.org/issues/1255).
3) Saya juga dapat bekerja pada pembaruan Tutorial dan skenario Katacoda (github.com/iterative/dvc.org/issues/670).
4) Jika bagian Petunjuk, memperbarui dokumen DVC 1.0 dan skenario Katacoda selesai sebelum akhir periode penulisan, maka sisa pekerjaan akan didasarkan pada prioritas DVC selama waktu itu dan tugas lain-lain.
Komitmen waktu:
Saya akan mengikuti kuliah reguler saya selama periode menulis. Saya tidak memiliki komitmen lain selain komitmen ini. Saya dapat meluangkan waktu 30 jam per minggu selama proyek berlangsung.