Move Kubernetes API types to the top

Đang mở
  • Có gì không ổn?
#56 1 bình luận 2 reaction 0 người được giao Xem trên GitHub

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
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ệ
go, kubernetes
Lĩnh vực
documentation

Hướng nghiên cứu

Tái hiện tài liệu tham chiếu được tạo ra bằng các kiểu tài nguyên tùy chỉnh Kubernetes có chứa các kiểu trợ giúp Go không liên quan, sau đó so sánh thứ tự tiêu đề với hành vi được mô tả trong gen-crd-api-reference-docs. Theo dõi cách trình tạo sắp xếp các kiểu được tham chiếu; hoàn thành khi các kiểu API xuất hiện trước các kiểu trợ giúp không liên quan thay vì chỉ được sắp xếp theo thứ tự chữ cái.

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

Mô tả

Something I'm observing from my https://github.com/ahmetb/gen-crd-api-reference-docs tool that's not ported here is that this tool is showing headings for various Go types referred in my Kubernetes custom resource types on top of the page because they're alphabetically first.

I think users would much rather prefer to scan API types first, and then see some unrelated Go helper type in the page.

Is this by design, or is there room for improvement here.

Ngôn ngữ chính
Go
Star
176
Fork
81
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

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.

Issue khác của elastic/crd-ref-docs

Tất cả issue của elastic/crd-ref-docs

Issue tương tự

Thêm issue về Go

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.