A consolidated section about building CP pages

Abierto
#208 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
CSS
Estrellas
22
Forks
79
Merge medio
2 d 1 h
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ExpressionEngine/ExpressionEngine-User-Guide

Todos los issues de ExpressionEngine/ExpressionEngine-User-Guide

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.