loopbackio / loopbackio/loopback-next

docs: move Controller recipes to how-to guides

Abierto
#6,108 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Docs
Lenguaje dominante
TypeScript
Estrellas
5.1k
Forks
1.1k
Merge medio
2 d 21 h
PR fusionados (30 d)
27

Descripción

At the moment, the Controllers page in "Behind the scenes" is mixing explanations with how-to guides. This makes it difficult for our users to find the relevant content (a recipe to achieve the outcome they want).

As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should extract all guides from explanation pages into guide pages (see #5768 for inspiration) and keep explanation pages focused on explaining the concepts & providing background information.

This story is a part of Epic #5783 move recipes to how-to guides.

Acceptance criteria

Move the following recipes into "How-to guides", decide yourself whether to create a new page for each recipe or group multiple recipes in one page.

Consider adding a "Common tasks" section to "Application" page, it should list pointers to new how-to guides. See Server >> Common tasks for inspiration.

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Empieza por la página Controllers e identifica las tres recetas enlazadas que deben trasladarse a How-to guides. Revisa la página Application y Server > Common tasks para conocer la estructura de referencias prevista, junto con las issues #5549, #5718, #5768 y #5783. Se considera terminado cuando las recetas se hayan trasladado, Controllers siga centrada en las explicaciones y se hayan actualizado los enlaces y las listas de comprobación pertinentes.

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

Evaluación

Stack tecnológico
nodejs, typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.