Revise overview page

Đang mở
  • Có gì không ổn?
#5,925 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ó
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ài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với trang tổng quan tại https://openliberty.io/docs/latest/overview.html và xem mục lục của trang trình bày các chủ đề trong phần hiển thị ban đầu như thế nào. So sánh cách tổ chức của trang với ví dụ Microsoft được liên kết, sau đó xác định các chủ đề chính hoặc phổ biến cần được đưa lên. Công việc được hoàn thành khi trang Welcome to Docs trình bày các chủ đề đó trong các bảng hữu ích mà không yêu cầu người dùng phải cuộn qua mục lục hiện có nằm ngoài màn hình.

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

Mô tả

The docs page (https://openliberty.io/docs/latest/overview.html) has a lot of good content. However, a lot of that TOC is off-screen when initially viewing the page and user needs to scroll to see all the important topics. I think the "Welcome to Docs" page can be improved to show the key (or popular) topics right on that page - e.g. assembled in a set of tables. Example: https://learn.microsoft.com/en-us/azure/developer/java/ee/

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

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.