Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Split plugin index page summary for better anchor links

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

Hướng nghiên cứu

Start from the plugin index page linked in the issue and inspect how its summary and table of contents are generated. Restructure the summary into the requested General, User, and optional Admin sections, with anchor links and conditional admin content; done when long plugin indexes are easier to navigate.

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

Mô tả

enhancement

Split the summary into sections, like:

# Welcome to plugin

{{ Plugin index page }}

---

## Summary

### General

* RESTAPI
* Changelog
* Github (maybe add this too)

### User

* User Home  # use plugin/user/index.md if it exists
* Guides
* Learn
* etc

### Admin

# omit Admin Home, if {plugin}/admin/index.md doesnt exit
* Guides
* Learn
* etc

The benefits of this are:

  • We can link to the whole "Admin" section of pulpcore, for example, if that doesnt have an index page.
  • Some repositories have long ToC (example, pulp-operator). This can help readabillity
Ngôn ngữ chính
HTML
Star
2
Fork
17
Merge trung bình
7 ngày 18 giờ
Pull request đã merge (30 ngày)
3

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

Tất cả issue của pulp/pulp-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.