A consolidated section about building CP pages

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

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
45/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
停滯
技術堆疊
php
領域
documentation

研究方向

Start with the Control Panel File section under Modules and the CP/Thing Service entries under Services, which the issue identifies as related material. Review those pages and gather links to the relevant steps for creating or modifying a CP page. Done means adding a consolidated Add-on section page with a best-practice overview or, at minimum, an index to the existing documentation.

由索引模型根據 Issue 內容生成。

描述

Suggested Change
Add a page within the Add-on development section that provides a consolidated best-practice view of how CP pages are generated and constructed.

Reasoning
Particularly following the introduction of the new more accessible UI in EE6 the CP is for many sites a critical domain. EE has long provided the ability to modify / add to the pages within the CP, and there are many methods provided by EE that are related to doing this within the documentation (e.g. the series of CP/Thing Service entries under Services).

However the documentation does not provide a consolidated description of or guide to the steps involved in either creating or modifying a CP page. Rather the expectation is that Developers construct their own understanding from the snippets spread through the documentation. It would be easier if there was (at the very least) a simple index page that listed links to relevant sections of the documentation.

The introduction to the Control Panel File section of the Modules entry comes close to providing some of these elements, but a) it is buried in another page, and b) provides at best only a partial view of what is involved in constructing a CP page.

主要語言
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 摘要。