CRD doc generation leads to bad formatting

Đang mở
#702 0 bình luận 0 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
42/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
kubernetes
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần CRD NiFi được kết xuất tại URL crds.stackable.tech được liên kết và xác định cách tài liệu Quantity được tạo ra. Theo dõi đầu vào đó qua luồng tạo tài liệu, sau đó xác minh rằng các trường Quantity bị ảnh hưởng được kết xuất mà không có định dạng sai trong tài liệu CRD đã tạo.

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

Mô tả

E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).

Image

Possible fixes:

  • We can try to remove that doc comment from rendering
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

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

  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 stackabletech/documentation

Tất cả issue của stackabletech/documentation

Issue tương tự

Thêm issue về Documentation

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.