[Feature Request]: Incorrect links to multi-version CRDs
Đá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
- 30/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ệ
- go, kubernetes
- Lĩnh vực
- documentation
Hướng nghiên cứu
issue #60 không nêu tên tệp mã nguồn hoặc bài kiểm thử nào. Hãy bắt đầu bằng cách xác định logic của generator tạo các anchor và liên kết Markdown cho các kiểu tài nguyên CRD có phiên bản, rồi so sánh hành vi mong đợi của nó với ví dụ Kubernetes Docs được liên kết. Công việc được hoàn thành khi các liên kết của v2 Foo và FooList chuyển đến các heading v2 tương ứng thay vì các heading v1.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
I used crd-ref-docs to generate API documentation for a multi-version CRD.
# API Reference
## Packages
- [example.dev/v1](#exampledevv1)
- [example.dev/v2](#exampledevv2)
## example.dev/v1
### Resource Types
- [Foo](#foo)
- [FooList](#foolist)
#### Foo
<- Jump to here
## example.dev/v2
### Resource Types
- [Foo](#foo) <- Click this
- [FooList](#foolist)
#### Foo
<- Expect to jump to here
Clicking on the v2 version of Foo redirects to the v1 version of Foo
Refer to the implementation of Kubernetes Docs
- Ngôn ngữ chính
- Go
- Star
- 176
- Fork
- 81
- 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 elastic/crd-ref-docs
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
elastic/crd-ref-docs#205 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
elastic/crd-ref-docs#204 ·
-
Support for +kubebuilder:validation:Required and omitemptyCó thể đã có người làm @swathinsankaran đã nhận 133 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
elastic/crd-ref-docs#198 · 1 reaction ·
-
[Feature request] JSON outputĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
elastic/crd-ref-docs#191 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
elastic/crd-ref-docs#188 · 2 bình luận ·
Tất cả issue của elastic/crd-ref-docs
Issue tương tự
-
date_time, url_encode, html_escape, to_unix_time, contains_all and contains_any panic when called without argumentsCó thể đã có người làm @antcybersec đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
projectdiscovery/dsl#372 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
JuliusBrussee/caveman#1449 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
clawsweeper:fix-shape-clear clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster P2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
openclaw/gogcli#1291 · 1 bình luận · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
apache/arrow-swift#209 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug(instrumentation/kafka-go): producer hook writes trace headers into the caller's messagesCó thể đã có người làm @Aryanbhargava18 đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
open-telemetry/opentelemetry-go-compile-instrumentation#1669 ·
Maintainer thường phản hồi trong vòng 2 ngày