stackabletech / stackabletech/documentation
Operator overview pages for internal operators (commons, secret, listener)
Đang mở
Chưa có ai nhận issue này.
area/documentation
size/M
- 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ả
Follow up to https://github.com/stackabletech/documentation/issues/282
Explain for every operator:
- which roles does it have and what do they mean?
- Which resources does it create:
- i.e. statefulsets per role
- configmap for discovery
- also a diagram
- which resources does it tear down again?
- for example, ConfigMaps and PVCs are staying
- what are the dependencies, what other operators does it connect to?
- link to demos
Operators:
- commons
- secret
- listener
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách đọc issue theo dõi #282 và kiểm tra tài liệu hiện có cho các operator commons, secret và listener. Với mỗi operator, hãy ghi lại các vai trò, các tài nguyên được tạo và được giữ lại hoặc bị xóa, các dependency, các sơ đồ và các liên kết demo của nó. Công việc hoàn tất khi các checkbox của cả ba operator đều được bao quát.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100