stackabletech / stackabletech/documentation

Operators: Turn examples into documentation

Đang mở
#287 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

priority/low refinement-needed
Ngôn ngữ chính
CSS
Star
13
Fork
14
Merge trung bình
4 ngày 8 giờ
Pull request đã merge (30 ngày)
10

Mô tả

We have the example directories in the operators, which are very useful for us devs to quicky deploy an instance of something. But the examples are not tested.

With the getting started guide we started moving examples into the docs and testing them. It would make sense to keep doing this, with the other examples as well. There are specific examples which deploy an instance + OPA etc., which we could turn into specific docs guides.

This would be an epic and needs to be done for all operators.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng việc xem xét các thư mục ví dụ về operator và hướng dẫn bắt đầu, nơi các ví dụ đã bắt đầu được chuyển thành tài liệu đã kiểm thử. Lập danh mục các ví dụ còn lại trên tất cả operator, xác định những ví dụ nào nên trở thành các hướng dẫn cụ thể, và định nghĩa việc hoàn thành là mỗi ví dụ được chọn đều được ghi tài liệu và kiểm thử.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.