loopbackio / loopbackio/loopback-next

docs: move recipes to how-to guides

Abierto
#5,783 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Docs epic Hacktoberfest
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, many pages in "Behind the scenes" are 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 #5113 Documentation improvements 2020Q3.

🎆 Hacktoberfest 2020

Greetings 👋 to everybody coming to this issue with the desire to help us improve our docs and score a pull request (or more?) in this year's Hacktoberfest challenge.

Here are few tips 👀 to make your start easier:

  • Pick a task (a doc page) from the check-list below and leave a comment to let others know that you are going to work on it. Some of the tasks have a dedicated GitHub issue created, please check that issue for more details.
  • Some doc pages have a lot of content, the amount of effort needed may feel intimidating. Don't worry! It's perfectly fine to pick just one section and convert it into a How-to guide. Baby steps FTW, every little helps!
  • If you are new to GitHub pull requests, then you can learn about the process in Submitting a pull request to LoopBack 4.
  • If this is your first contribution to LoopBack documentation, then read Documentation guide for LoopBack 4 developers please. Consider previewing loopback-next docs only for a faster feedback loop. Finally, please refer to Contributing to LoopBack documentation for a more advanced information on our Jekyll-based documentation infrastructure.
  • Feel free to ask for help in #loopback-contributors channel, you can join our Slack workspace here.

📋 List of pages to rework

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

Elige una página no marcada de la lista de comprobación, como Application.html, Controllers.html o una página de relaciones, y léela junto con las directrices de documentación de los cuatro cuadrantes y el issue #5768. Extrae su contenido práctico en una página de guía, manteniendo el original centrado en los conceptos y el contexto. Se considera completado cuando la página seleccionada se haya reelaborado y se haya actualizado su elemento de la lista de comprobación o el issue dedicado.

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

Evaluación

Stack tecnológico
jekyll
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.