jenkinsci / jenkinsci/java-client-api

Bad documentation

Đang mở
#385 1 bình luận 2 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
Java
Star
913
Fork
466
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The http://jenkinsci.github.io/java-client-api/ link leads to a boilerplate, useless website.

How about instead, we publish the javadocs online, so that users can navigate the available classes more quickly?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by checking the current project build and documentation-publishing entry points, then compare the generated output with the boilerplate site at http://jenkinsci.github.io/java-client-api/. Done means the public link serves navigable Java API documentation covering the available classes instead of the boilerplate page.

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

Đánh giá

Công nghệ
java
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

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.