stackabletech / stackabletech/documentation
Automate reference docs for commandline flags and env vars
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ả
Problem: Currently we have hand written docs in every operator about commandline flags and environment variables read by the operators. This is difficult to maintain and in some places it is already out of date. Like the CRD references, it would be good to generate this to reduce maintenance burden.
Cheapo variant A: dump the help page
The help pages of the operators actually already reference all the flags (obviously) and also most env vars (some would need to be added through clap, that is easy though). We already do this for stackablectl. It isn't pretty, the formatting is actually quite ugly.
By default the help doesn't show help for subcommands. Maybe we have to call each subcommand individually (or maybe we just show the help for run).
Slightly more involved variant B: generate man page, convert to adoc
There is https://github.com/clap-rs/clap/tree/master/clap_mangen to generate man pages from clap.
We could use pandoc to convert the man page to an adoc file:
pandoc -s -t asciidoc example.man -o example.adoc
And use that as our reference page.
This is a bit annoying to implement because the build.rs file has to include the clap parser definition too. Also I am unsure about the pandoc converted adoc page, I am not sure if the styling can be changed or how easily it can be done.
For reference (currently manually generated):
https://docs.stackable.tech/home/stable/hbase/reference/commandline-parameters/
https://docs.stackable.tech/home/stable/hbase/reference/environment-variables/
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
Xem lại workflow hiện có để tạo tài liệu tham chiếu CRD và các trang tham chiếu về dòng lệnh và biến môi trường của HBase được tạo thủ công. Sau đó, so sánh đầu ra trợ giúp của các operator với phần tích hợp build.rs và bộ phân tích cú pháp clap được mô tả trong issue, bao gồm cả việc liệu các subcommands có cần được xử lý riêng hay không. Hoàn thành có nghĩa là lựa chọn và triển khai một phương pháp tạo tài liệu có thể bảo trì, tạo ra các trang tham chiếu có thể sử dụng mà không cần viết thủ công các danh sách flag và biến môi trường.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- rust
- Lĩnh vực
- build-system, documentation
- Loại issue
- Tính năng
- Độ 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
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100