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 Controller recipes to how-to guides #6108

Open
3 tasks
bajtos opened this issue Aug 13, 2020 · 3 comments
Open
3 tasks

docs: move Controller recipes to how-to guides #6108

bajtos opened this issue Aug 13, 2020 · 3 comments
Labels

Comments

@bajtos
Copy link
Member

bajtos commented Aug 13, 2020

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.

@dhmlau dhmlau added this to the Oct 2020 milestone Sep 11, 2020
@dhmlau dhmlau removed the 2020Q3 label Sep 11, 2020
@mrmodise
Copy link
Contributor

mrmodise commented Oct 27, 2020

Will take this on. Thanks JannyHou took it over

@dhmlau dhmlau modified the milestones: Oct 2020, Nov 2020 Oct 27, 2020
@jannyHou jannyHou self-assigned this Oct 27, 2020
@mrmodise
Copy link
Contributor

@jannyHou if you don't I can take this on?

@jannyHou
Copy link
Contributor

jannyHou commented Nov 5, 2020

Hi @mrmodise I was on vacation :p I have some other tasks to work on, please feel free to take this task, appreciate it.

@dhmlau dhmlau removed this from the Nov 2020 milestone Nov 24, 2020
@stale stale bot added the stale label Sep 27, 2021
@achrinza achrinza removed the stale label Sep 27, 2021
@loopbackio loopbackio deleted a comment from stale bot Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants