Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move recipes to how-to guides #5783

Open
3 of 20 tasks
bajtos opened this issue Jun 19, 2020 · 2 comments
Open
3 of 20 tasks

docs: move recipes to how-to guides #5783

bajtos opened this issue Jun 19, 2020 · 2 comments
Labels
Docs epic Hacktoberfest Tasks ready for new contributors to work on

Comments

@bajtos
Copy link
Member

bajtos commented Jun 19, 2020

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

@bajtos bajtos changed the title [Docs] Move recipes to how-to guides docs: move recipes to how-to guides Jun 19, 2020
@bajtos
Copy link
Member Author

bajtos commented Jun 22, 2020

Added a placeholder estimate 40sp

@bajtos
Copy link
Member Author

bajtos commented Aug 13, 2020

Created first few sub-tasks (user stories) to kick-off the effort.

The intention is to have stories only for the work we can do in the next few weeks/months, so that we don't spam backlog with 20 stories that will sit there for a while. When we complete the first round, then we will create more stories.

/cc @dhmlau

@dhmlau dhmlau removed the 2020Q3 label Sep 11, 2020
@bajtos bajtos added the Hacktoberfest Tasks ready for new contributors to work on label Sep 22, 2020
@bajtos bajtos pinned this issue Nov 24, 2020
@bajtos bajtos unpinned this issue Nov 24, 2020
@stale stale bot added the stale label Sep 27, 2021
@loopbackio loopbackio deleted a comment from stale bot Sep 27, 2021
@stale stale bot removed the stale label Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs epic Hacktoberfest Tasks ready for new contributors to work on
Projects
None yet
Development

No branches or pull requests

2 participants