Split plugin index page summary for better anchor links
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pulp/pulp-docs のほかの issue
-
epic
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
-
documentation
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
-
Add issue templates オープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100