Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- DVC
- Người viết nội dung kỹ thuật:
- imhardikj
- Tên dự án:
- Triển khai hướng dẫn trong phần "Cách thực hiện" và cập nhật tài liệu về DVC 1.0
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Một trong những mục tiêu của dự án này là triển khai phần "Cách thực hiện" để giải đáp chi tiết các câu hỏi thường gặp liên quan đến DVC. Mục tiêu tiếp theo là cập nhật tài liệu theo bản phát hành DVC 1.x mới nhất. Có những thay đổi đáng kể so với các bản phát hành trước đó, do đó, tài liệu cần được cập nhật lên phiên bản mới nhất. Sau khi hoàn tất, các nhiệm vụ tiếp theo sẽ dựa trên các mức độ ưu tiên của DVC trong thời gian viết.
Mục tiêu của dự án:
1) Một số ví dụ về phần "Cách thực hiện" được đề xuất: - Cách ""huỷ"" lệnh "dvc add" (Cách huỷ lỗi). – Cách thêm phần phụ thuộc bị thiếu vào quy trình hiện có. – Cách sử dụng DVC khi dữ liệu được lưu trữ trong ổ đĩa ngoài (Hướng dẫn quản lý dữ liệu bên ngoài).
Đây là một số ý tưởng dựa trên vấn đề GitHub (github.com/iterative/dvc.org/issues/899) có thể được đưa vào phần này. Việc này cũng bao gồm việc di chuyển một số tài liệu hiện có (ví dụ: "Chạy DVC trên Windows") vào phần này. Nếu một mục tiêu hướng dẫn không phù hợp với phần này, thì bạn có thể cập nhật mục tiêu đó trong tài liệu tham khảo lệnh (hoặc tài liệu có liên quan) kèm theo ví dụ. Phần này có thể được mở rộng để bao gồm nhiều vấn đề về cách làm hơn bất cứ khi nào tôi gặp phải trên các kênh cộng đồng.
2) Phần quan trọng khác của dự án này là cập nhật tài liệu hiện đã phát hành DVC 1.0 (dvc.org/blog/dvc-1-0-release) và theo các bản cập nhật có liên quan khác có thể được phát hành vào tháng 9. Tài liệu (tất cả các tài liệu tham khảo về lệnh, v.v.) nên được cập nhật theo các thay đổi này, một số trong số đó được đề cập trong vấn đề hoành tráng này (github.com/iterative/dvc.org/issues/1255).
3) Tôi cũng có thể cập nhật các hướng dẫn và tình huống Katacoda (github.com/iterative/dvc.org/issues/670).
4) Nếu phần Cách thực hiện, việc cập nhật tài liệu DVC 1.0 và các tình huống Katacoda đã hoàn tất trước khi kết thúc thời gian viết, thì phần công việc còn lại sẽ dựa trên các ưu tiên của DVC trong thời gian đó và các nhiệm vụ khác.
Cam kết về thời gian:
Tôi sẽ có lớp học đại học thông thường trong thời gian viết bài. Tôi không có cam kết nào khác ngoài việc này. Tôi có thể cam kết dành 30 giờ mỗi tuần trong toàn bộ thời gian của dự án.