Generated reference pages for wrapped commands show talosctl in the examples
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 67/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- go
- Lĩnh vực
- documentation
Hướng nghiên cứu
Read the Cobra-based reference-page generation path and compare docs/reference/image_cache-create.md with the upstream talosctl examples; also inspect docs/reference/image_integration.md for the duplicate flag descriptions. Decide whether to rewrite wrapped-command examples during generation or label them as upstream examples, and clarify what --installer-tag and --talos-tag select. Done when the generated pages distinguish talm commands from upstream examples and the two flag descriptions are distinguishable.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
docs/reference/image_cache-create.md documents talm image cache-create, and then gives these examples:
talosctl images cache-create --images=... --image-cache-path=...
talosctl images default | talosctl images cache-create --image-cache-path=... --images=-
That block is upstream talosctl's own example text. It reaches the talm reference because talm wraps the command and the pages are generated from the cobra tree. Someone copying from a talm page runs a binary they may not have installed.
docs/reference/image_integration.md has the same root cause in a different shape: --installer-tag and --talos-tag carry the identical description ("tag of the installer image to use"), so there is no way to tell which one selects what.
Either rewrite the examples for wrapped commands at generation time, or label them on the page as upstream talosctl examples.
- Ngôn ngữ chính
- Go
- Star
- 493
- Fork
- 23
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 4
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 cozystack/talm
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
area/apply area/commands area/upgrade kind/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Tất cả issue của cozystack/talm
Issue tương tự
-
agent-research agent-review-finding chore
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
jordansmall/spindrift#4922 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
gcsartifact: deleting a missing version returns an errorCó thể đã có người làm @ktsoator đã nhận hôm nay. Đang mởbug
Độ 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 2 ngày
-
govulncheck
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Change wording for init command success messageCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement pkg:sdk
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
aws/aws-durable-execution-sdk-go#144 ·
Maintainer thường phản hồi trong vòng 1 ngày