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ở:
- Nền tảng điện toán đám mây gốc (CNCF)
- Người viết nội dung kỹ thuật:
- Syam Sundar K
- Tên dự án:
- Ví dụ về Kubectl nhiều hơn và phù hợp hơn
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Mục tiêu của dự án này là cải thiện bản tóm tắt về kubectl và tài liệu tham khảo hiện có.
Đây là những mục tiêu sau cùng của dự án này: • Tạo nhiều ví dụ kubectl hơn và hay hơn. • Thêm các ví dụ về kubectl vào bản tóm tắt về kubectl. • Tái cấu trúc các tài liệu của kubectl để đạt được mức độ hữu ích tối đa.
Mục tiêu I – Ví dụ về kubectl:
Sẽ phối hợp chặt chẽ với các nhóm có cùng mối quan tâm đặc biệt của CLI để nắm được bối cảnh cũng như biết được những loại ví dụ mà người dùng Kubernetes muốn nhất và ghi lại. Bạn có thể làm việc này từ việc cải thiện các lệnh kubectl hiện có trên bản tóm tắt cho đến việc thêm các lệnh mới vào bản tóm tắt.
Mục tiêu II – Tăng mức độ hữu ích của tài liệu:
Để tăng tính hữu ích của tài liệu, bạn có thể làm những việc sau:
• Loại bỏ những khó khăn của người mới bắt đầu • Sắp xếp lại lệnh kubectl theo thứ tự nhất định để đảm bảo tính liên tục trong luồng logic
Loại bỏ những khó khăn cho người mới bắt đầu nhờ tính năng giải thích lệnh / trường hợp người dùng chính xác hơn. Việc này có vẻ đơn giản nhưng lại có thể ảnh hưởng đáng kể đến việc người dùng bắt đầu tiếp tục hoặc bỏ học. Chẳng hạn, khi tôi bắt đầu sử dụng kubernetes thông qua kubectl, tôi không chắc về sự khác biệt giữa nhóm và quá trình triển khai. Ban đầu, tôi triển khai dịch vụ phụ trợ được viết bằng buttonjs. Sau vài giờ, tôi muốn gỡ bỏ nhóm này, vì vậy tôi đã cố gắng xoá nhóm này, nhưng do bản chất tự phục hồi của các nhóm trên đó, chúng lại được tạo lại. Tôi rất bối rối với những gì đang diễn ra và tự hỏi tại sao nó được tạo lại mà không bị xoá. Sau một vài lần tra cứu trên web, tôi nhận ra việc xoá các nhóm không giống như việc xoá một bản triển khai. Đối với những người đã qua đào tạo, điều này có vẻ đơn giản nhưng giải thích rõ ràng giúp loại bỏ những mơ hồ không rõ ràng chính là yếu tố phân biệt một tài liệu hay với một tài liệu tuyệt vời.
Sắp xếp lại các lệnh kubectl theo một thứ tự nhất định để đảm bảo tính liên tục trong luồng logic. Nếu là một người như tôi rất tin tưởng vào cách kể chuyện, có lẽ bạn sẽ thắc mắc, làm thế nào để đưa các yếu tố kể chuyện vào một trang tài liệu có danh sách các lệnh đầu cuối, tôi nói là có thể thực hiện được. Mọi thứ chúng tôi học được đều luôn có một luồng logic, đó là điểm bắt đầu và điểm kết thúc, nếu bạn muốn. Kubectl là một công cụ dòng lệnh rõ ràng có quy trình học tập cần thiết. Trên thực tế, lộ trình học tập của công cụ này trùng với lộ trình học tập của chính Kubernetes. Hầu hết mọi người đều bắt đầu hành trình với kubernetes thông qua kubectl (ngoại trừ những người sử dụng giao diện người dùng web). Vì quá trình học tập của Kubernetes kết hợp chặt chẽ với lộ trình học tập của Kubernetes, nên các tài liệu sẽ trở nên tốt hơn đáng kể chỉ bằng cách thay đổi thứ tự các lệnh và giới thiệu các yếu tố kể chuyện. Chẳng hạn, bạn có thể giải thích các tính năng như tự động cấp tài nguyên bổ sung cho nhóm theo chiều ngang sau khi giải thích tài nguyên bằng ví dụ và hình minh hoạ thực tế.
Mục tiêu III – Cải thiện khả năng sử dụng của Tài liệu:
Quá trình di chuyển trang web của Kubernetes sang Docsy Hugo gần đây rất tuyệt vời và là một sự thay đổi lớn trong góc nhìn về tài liệu. Mặc dù quá trình di chuyển đã thành công, nhưng chúng tôi vẫn còn nhiều điểm cần cải tiến về tài liệu.
Sau đây là một số thay đổi mà tôi sẽ đề xuất
• Ngăn bên trái tự động cuộn đến phần hiện đang hoạt động trên tài liệu chính – Tính năng này có thể hữu ích trong việc theo dõi các phần hiện tại, sắp tới và trước đây. • Sao chép vào bảng nhớ tạm – một số lệnh có thể dài, nhưng chức năng sao chép có thể hữu ích khi làm việc với các loại lệnh này. • Định dạng nội dung của tệp tài liệu – Sau khi di chuyển, nội dung trong một số trang chưa được định dạng theo cách phù hợp. Ví dụ: phần Loại tài nguyên trong phần tổng quan của kubectl. Điều này sẽ làm giảm chất lượng trải nghiệm người dùng.
Đây là những thay đổi giúp nâng cao trải nghiệm người dùng trên trang web Kubernetes và cũng có thể giúp tăng năng suất của người dùng.