หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- DVC
- ผู้เขียนด้านเทคนิค:
- อิมฮาร์ดิก
- ชื่อโปรเจ็กต์:
- การใช้คำแนะนำในส่วน "วิธีการ" และการอัปเดตเอกสาร DVC 1.0
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
จุดมุ่งหมายหนึ่งของโครงการนี้คือ นำส่วน "วิธีการ" ไปใช้ตอบคำถามที่พบบ่อยเกี่ยวกับ DVC ด้วยรายละเอียด เป้าหมายต่อไปคือการอัปเดตเอกสารประกอบตามการเผยแพร่ DVC 1.x ล่าสุด มีการเปลี่ยนแปลงที่สำคัญเมื่อเทียบกับรุ่นก่อนหน้า ดังนั้นเอกสารจึงจำเป็นต้องอัปเดตเป็นเวอร์ชันล่าสุด หลังจากเสร็จสมบูรณ์ งานถัดไปจะเป็นไปตามลำดับความสำคัญของ DVC ในช่วงเวลาที่เขียน
เป้าหมายของโครงการ:
1) ตัวอย่างบางส่วนสำหรับส่วน "วิธีการ" ที่นำเสนอ ได้แก่ - วิธี ""เลิกทำ"" "เพิ่ม DVC" (วิธีเลิกทำข้อผิดพลาด) - วิธีเพิ่มทรัพยากร Dependency ที่ขาดหายไปลงในไปป์ไลน์ที่มีอยู่ - วิธีใช้ 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 ชั่วโมงตลอดระยะเวลาของโครงการ