Publish Form Tabs missing supporting documentation

オープン
#946 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
php
領域
documentation

調査の方向性

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.

  1. 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.
  2. 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

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ExpressionEngine/ExpressionEngine-User-Guide のほかの issue

ExpressionEngine/ExpressionEngine-User-Guide の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。