Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
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 gian 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 "Hướng dẫn" giải đáp chi tiết những 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, vì vậy bạn phải cập nhật tài liệu 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 mức độ ưu tiên của DVC trong giai đoạn viết.
Mục tiêu dự án:
1) Một số ví dụ cho phần "Cách thực hiện" được đề xuất: – Cách ""huỷ"" 'thêm dvc' (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 bao gồm trong phần này. Điều này cũng bao gồm việc 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 về lệnh (hoặc tài liệu có liên quan) kèm theo ví dụ. Tôi có thể mở rộng phần này để trình bày thêm nhiều vấn đề liên quan đến hướng dẫn cách làm mỗi khi tôi bắt gặp những vấn đề đó 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 khi DVC 1.0 được phát hành (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ả tài liệu tham khảo lệnh, v.v.) phải được cập nhật theo các thay đổi này, một số thay đổi được đề cập trong vấn đề lớn này (github.com/iterative/dvc.org/issues/1255).
3) Tôi cũng có thể cập nhật các kịch bản hướng dẫn và Katacoda (github.com/iterative/dvc.org/issues/670).
4) Nếu phần Hướng dẫn, cập nhật tài liệu DVC 1.0 và các kịch bản Katacoda được hoàn thành trước khi kết thúc giai đoạn viết, thì phần còn lại của công việc sẽ dựa trên mức độ ưu tiên của DVC trong thời gian đó và các nhiệm vụ khác.
Cam kết thời gian:
Tôi sẽ học đại học chính quy trong thời gian viết. Tôi không có cam kết nào khác ngoài cam kết này. Tôi sẽ có thể cam kết dành 30 giờ mỗi tuần trong toàn bộ thời gian của dự án.