stackabletech / stackabletech/documentation

Operator env vars documentation

Đang mở
#515 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.

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ả

currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.

The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)

These things should go into the Reference section.

We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.

related: https://github.com/stackabletech/documentation/issues/514

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 cách xác định tài liệu hiện có được viết thủ công về các biến môi trường và tham số dòng lệnh, sau đó xem lại các phần Reference và issue liên quan 514. Công việc được xem là hoàn tất khi các thiết lập được ghi lại dưới dạng mà người dùng có thể áp dụng với Helm hoặc OpenShift, đồng thời mọi quyết định về partial dùng chung hoặc việc tạo sinh đều được ghi lại trong tài liệu kết quả.

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

Đánh giá

Công nghệ
helm
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
38/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.