Add an `Example` field to the mixlib-cli spec
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- ruby
- Lĩnh vực
- cli, documentation
Hướng nghiên cứu
Bắt đầu bằng cách xác định đặc tả tùy chọn của mixlib-cli và các đường dẫn formatter được đề cập trong issue. Theo dõi cách siêu dữ liệu tùy chọn được xuất trên dòng lệnh và vào đầu ra .rst hoặc .md, sau đó xác định hành vi của trường Example và kiểm tra rằng các ví dụ dòng lệnh được xử lý chính xác trong từng định dạng đầu ra.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Motivation
As a technical writer
I want to add examples to the CLI docs
so that users will know the tricky bits and we can automate the CLI docs
The documentation team is working towards meaningful automation of our reference documentation (CLI, API, config). Hand-curating CLI examples and scattering them throughout the documentation by means of dtags, partials, or includes makes the documentation lifecycle difficult to manage. Adding an example field that can handle (or, at the very least, ignore) command line examples such as --bootstrap-vault-json '{ "vault1": ["item1", "item2"], "vault2": "item2" }' would help both users and the docs team.
Specification
:example - An example showing the syntax to use with this option. Example "--bootstrap-vault-json '{ "vault1": ["item1", "item2"], "vault2": "item2" }' "
Downstream Impact
This would impact the formatter and how we output the CLI docs, both on the command line and into .rst or .md
- Ngôn ngữ chính
- Ruby
- Star
- 118
- Fork
- 40
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
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.
Issue khác của chef/mixlib-cli
-
Triage: Feature Request
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
chef/mixlib-cli#70 ·
-
Long options that start with `--no-*` are negated even when its explicitly defined as an optionĐang mởType: Bug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
chef/mixlib-cli#48 · 1 bình luận ·
-
Option validationsĐang mởTriage: Feature Request
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
chef/mixlib-cli#38 · 1 bình luận ·
-
Triage: Feature Request
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
chef/mixlib-cli#27 ·
Tất cả issue của chef/mixlib-cli
Issue tương tự
-
ETQ admin, le select de condition d'une annotation répétable liste les champs publics deux foisĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
demarche-numerique/demarche.numerique.gouv.fr#14301 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
needs verification
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 6 ngày
-
L: java:gradle L: java:maven L: ruby:bundler T: bug 🐞
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
dependabot/dependabot-core#16547 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Properties named open and close collide with query delimiter tokensCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 8 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày