loopbackio / loopbackio/loopback-next

docs: move recipes to how-to guides

Aperta
#5,783 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Docs epic Hacktoberfest
Lingua principale
TypeScript
Stelle
5.1k
Fork
1.1k
Merge medio
2g 21h
PR unite (30g)
27

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Scegli una pagina non ancora spuntata dalla checklist, ad esempio Application.html, Controllers.html o una pagina relativa a una relazione, e leggila insieme alle linee guida sulla documentazione a quattro quadranti e all’issue #5768. Estrai i contenuti how-to in una pagina guida, mantenendo l’originale focalizzato sui concetti e sul contesto. Il lavoro è completato quando la pagina selezionata è stata rielaborata e il relativo elemento della checklist o l’issue dedicata è stato aggiornato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jekyll
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.