หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- DVC
- นักเขียนเชิงเทคนิค:
- imhardikj
- ชื่อโปรเจ็กต์:
- การใช้คําแนะนําในส่วน "วิธีการ" และการอัปเดตเอกสาร DVC 1.0
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
เป้าหมายอย่างหนึ่งของโครงการนี้คือการใช้ส่วน "วิธีการ" ซึ่งตอบคำถามทั่วไปเกี่ยวกับ DVC อย่างละเอียด เป้าหมายถัดไปคือการอัปเดตเอกสารประกอบตามรุ่น DVC 1.x ล่าสุด มีการเปลี่ยนแปลงที่สำคัญเมื่อเทียบกับรุ่นก่อนหน้า จึงจำเป็นต้องอัปเดตเอกสารเป็นเวอร์ชันล่าสุด หลังจากเขียนเสร็จแล้ว งานถัดไปจะยึดตามลำดับความสำคัญของ DVC ระหว่างระยะเวลาการเขียน
เป้าหมายโครงการ:
1) ตัวอย่างสำหรับส่วน "วิธีการ" ที่เสนอมีดังนี้ - วิธี ""เลิกทำ"" "เพิ่ม dvc" (วิธีเลิกทำข้อผิดพลาด) - วิธีเพิ่มข้อกําหนดเบื้องต้นที่ขาดหายไปลงในไปป์ไลน์ที่มีอยู่ - วิธีใช้ DVC เมื่อจัดเก็บข้อมูลไว้ในไดรฟ์ภายนอก (คู่มือการจัดการข้อมูลภายนอก)
ต่อไปนี้คือแนวคิดบางส่วนที่อิงตามปัญหาใน GitHub (github.com/iterative/dvc.org/issues/899) ซึ่งสามารถรวมไว้ในส่วนนี้ได้ ซึ่งเกี่ยวข้องกับการย้ายเอกสารประกอบที่มีอยู่บางส่วน (เช่น "การเรียกใช้ DVC บน Windows") ไปไว้ในส่วนนี้ด้วย หากเป้าหมายวิธีการไม่เหมาะกับส่วนนี้ คุณสามารถอัปเดตเป้าหมายดังกล่าวในข้อมูลอ้างอิงคำสั่ง (หรือเอกสารประกอบที่เกี่ยวข้อง) พร้อมตัวอย่าง ส่วนนี้สามารถขยายให้ครอบคลุมปัญหาเกี่ยวกับวิธีต่างๆ เพิ่มเติมได้เมื่อเราพบปัญหาเหล่านั้นในช่องชุมชน
2) ส่วนสําคัญอีกอย่างหนึ่งของโปรเจ็กต์นี้คือ การอัปเดตเอกสารประกอบเมื่อ DVC 1.0 เปิดตัวแล้ว (dvc.org/blog/dvc-1-0-release) และตามการอัปเดตอื่นๆ ที่เกี่ยวข้องซึ่งอาจเปิดตัวภายในเดือนกันยายน เอกสาร (การอ้างอิงคำสั่งทั้งหมด ฯลฯ) ควรได้รับการอัปเดตตามการเปลี่ยนแปลงเหล่านี้ ซึ่งบางส่วนมีการกล่าวถึงในปัญหาที่ยิ่งใหญ่นี้ (github.com/iterative/dvc.org/issues/1255)
3) เรายังอัปเดตบทแนะนำและสถานการณ์ของ Katacoda ได้ด้วย (github.com/iterative/dvc.org/issues/670)
4) หากส่วนวิธีการ การอัปเดตเอกสาร DVC 1.0 และสถานการณ์ของ Katacoda ดำเนินการเสร็จสิ้นก่อนสิ้นสุดระยะเวลาเขียน งานที่เหลือจะขึ้นอยู่กับลำดับความสำคัญของ DVC ในช่วงเวลาดังกล่าวและงานเบ็ดเตล็ดอื่นๆ
สัญญาผูกมัดเวลา
ฉันจะได้เรียนในมหาวิทยาลัยระหว่างระยะเวลาการเขียน ฉันไม่มีภาระหน้าที่อื่นใดนอกจากนี้ ฉันสามารถใช้เวลาสัปดาห์ละ 30 ชั่วโมงตลอดระยะเวลาของโครงการ