Split plugin index page summary for better anchor links
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- html
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- HTML
- 星标
- 2
- 派生
- 17
- 平均合并
- 7 天 18 小时
- 30 天内合并 PR
- 3
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
pulp/pulp-docs 的其他 Issue
-
epic
难度 5/5 一周以上 新手友好度 25/100
-
bug
难度 3/5 1-2 天 新手友好度 48/100
-
documentation
难度 3/5 1-2 天 新手友好度 45/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 55/100
-
enhancement
难度 3/5 1-2 天 新手友好度 45/100
相似的 Issue
-
area:breg criticality:p3 documentation triage:needs-implementation
难度 1/5 1 小时以内 新手友好度 86/100
registrystack/registry-stack#1713 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
posit-dev/ggsql#565 · 1 个 reaction ·
维护者通常 1 天内回复
-
documentation easy good first issue help wanted
难度 2/5 1-3 小时 新手友好度 85/100
lacs-project/sysknife#518 ·
维护者通常 1 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 88/100
qgis/QGIS-Plugins-Website#459 ·
-
bot-found documentation priority: P3
难度 2/5 1-3 小时 新手友好度 76/100
madenvel/KalinkaPlayer#178 ·