Investigate how to build other REST API generated docs

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

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
openapi
Lĩnh vực
documentation

Hướng nghiên cứu

Trước tiên, hãy xem lại tài liệu OpenAPI REST API trên trang KC được liên kết và epic autogen (#2615) để xác định hiện các Batch REST APIs và JMX REST Connector REST APIs được xây dựng như thế nào. Thảo luận các phát hiện với Michal và Alasdair; công việc được xem là hoàn tất khi cách tiếp cận xây dựng đã được ghi lại và một issue theo dõi được ưu tiên đã được tạo để tích hợp các tài liệu này vào tài liệu Open Liberty.

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

Mô tả

As well as the Liberty API/SPI docs that we've discussed previously (and mentioned in the autogen epic), there are some OpenAPI REST API docs in the KC that Alasdair has previously said do need to come over the OL docs. These are API docs generated by OpenAPI for APIs that are provided to use with Liberty (Batch REST APIs, and JMX REST Connector REST APIs) (so, to be clear, this has nothing to do with the OL support for MicroProfile OpenAPI etc).

Alasdair's comment when we first audited the KC, was that we need to start by finding out how the KC is currently building these docs. Then, talk to Michal about how we get these docs built into the OL docs, and will probably need an issue creating then like we have for the API/SPI docs. That issue should probably be added to the autogen epic and prioritised with Alasdair against the other issues listed there.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
14
Fork
58
Merge trung bình
1 giờ
Pull request đã merge (30 ngày)
25

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 OpenLiberty/docs

Tất cả issue của OpenLiberty/docs

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.