Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- DVC
- Teknik yazar:
- imhardikj
- Proje adı:
- "Nasıl yapılır?" bölüm kılavuzlarını uygulama ve DVC 1.0 dokümanlarını güncelleme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projenin amaçlarından biri, DVC ile ilgili sık sorulan soruları ayrıntılı olarak ele alan bir "Nasıl Yapılır?" bölümü uygulamaktır. Sonraki hedefimiz, dokümanları en son DVC 1.x sürümüne göre güncellemektir. Önceki sürümlere kıyasla önemli değişiklikler olduğu için dokümanların en yeni sürüme güncellenmesi gerekiyor. Bu işlem tamamlandıktan sonra, sonraki görevler yazım döneminde DVC'nin önceliklerine göre belirlenir.
Proje hedefleri:
1) Önerilen "Nasıl yapılır?" bölümüne yönelik bazı örnekler: - "dvc add" komutunu "geri alma" (Hataları geri alma). - Mevcut bir ardışık düzene eksik bağımlılık ekleme. - Veriler harici bir sürücüde depolandığında DVC'yi kullanma (Harici veri yönetimi kılavuzu).
Aşağıda, Github sorununa (github.com/iterative/dvc.org/issues/899) dayalı ve bu bölüme dahil edilebilecek fikirlerden bazıları verilmiştir. Mevcut dokümanların bir kısmını da (ör. "Windows'ta DVC'yi çalıştırma") bu bölüme taşıdık. Bir nasıl yapılır hedefi bu bölüm için uygun değilse komut referansında (veya ilgili dokümanda) bir örnekle güncellenebilir. Topluluk kanallarında karşılaştığım diğer nasıl yapılır sorularını da bu bölüme ekleyebilirim.
2) Bu projenin diğer önemli kısmı, DVC 1.0 yayınlandığına göre (dvc.org/blog/dvc-1-0-release) ve Eylül'e kadar yayınlanabilecek diğer ilgili güncellemelere göre dokümanları güncellemektir. Dokümanlar'ın (tüm komut referanslarının vb.) bu değişikliklere göre güncellenmesi gerekir. Bu değişikliklerin bir kısmı bu destansı sayıda (github.com/iterative/dvc.org/issues/1255) ele alınmaktadır.
3) Eğitimleri ve Katacoda senaryolarını güncelleme konusunda da çalışabilirim (github.com/iterative/dvc.org/issues/670).
4) Nasıl yapılır bölümü, DVC 1.0 dokümanlarını güncelleme ve Katacoda senaryoları yazım dönemi sona ermeden tamamlanırsa çalışmanın geri kalanı, o dönemdeki DVC önceliklerine ve diğer çeşitli görevlere göre belirlenir.
Zaman taahhüdü:
Yazma döneminde normal derslerime devam edeceğim. Bunun dışında başka taahhütlerim yok. Projenin tamamı boyunca haftada 30 saat çalışabilirim.