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 摘要。