Publish Form Tabs missing supporting documentation
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- php
調査の方向性
Start by reading the tab-file, add-on setup, and add-on update documentation pages named in the issue. Clarify what it means to indicate a tab in the update file, document the tabs() function and its use during installation and uninstallation, and consider adding a table of contents to the update-file page. Done when the documentation explains these steps clearly.
索引モデルが issue の本文から書いたものです。
説明
Description of the problem
On https://docs.expressionengine.com/latest/development/tab-files.html#anatomy-of-a-tab-file it includes a note:
Note: if your module includes a tab, do not forget to indicate this in the update file when installing the module. Further, be sure to include the tabs() function in the update file, and use it when updating custom layouts on installation and uninstallation.
This doesn't really provide any useful information until more context is added to other places in the documentation.
- It's not clear what "indicate this in the update file" means or how to do that. https://docs.expressionengine.com/latest/development/addon-setup-php-file.html doesn't seem to have any additional information about that.
- https://docs.expressionengine.com/latest/development/add-on-update-file.html doesn't have any information about the
tabs()function.
Edit: adding a Table of Contents to https://docs.expressionengine.com/latest/development/add-on-update-file.html would be helpful too.
- 主要言語
- CSS
- スター
- 22
- フォーク
- 79
- 平均マージ
- 2日 1時間
- マージ済み PR(30日)
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ExpressionEngine/ExpressionEngine-User-Guide のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 46/100
ExpressionEngine/ExpressionEngine-User-Guide の issue をすべて見る
似ている issue
-
hermes-queue
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
chrisalunlloyd2-sudo/mindpalace#337 ·
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 87/100
OWASP/CheatSheetSeries#2905 ·
メンテナーはふだん 1 日以内に返信
-
Cleanup Setup対応中かも @AlexanderKaran が今日担当しました。 オープンdocumentation enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
e18e/framework-tracker#769 ·
メンテナーはふだん 1 日以内に返信
-
bug v2
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
modelcontextprotocol/servers#5483 ·
メンテナーはふだん 1 日以内に返信