Publish Form Tabs missing supporting documentation

未關閉
#946 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
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 小時
30 天內合併 PR
6

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

ExpressionEngine/ExpressionEngine-User-Guide 的其他 Issue

查看 ExpressionEngine/ExpressionEngine-User-Guide 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。