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 "Parsing requests" recipes to how-to guides #6110

Closed
4 tasks
bajtos opened this issue Aug 13, 2020 · 0 comments · Fixed by #6695
Closed
4 tasks

docs: move "Parsing requests" recipes to how-to guides #6110

bajtos opened this issue Aug 13, 2020 · 0 comments · Fixed by #6695
Assignees
Labels
Milestone

Comments

@bajtos
Copy link
Member

bajtos commented Aug 13, 2020

At the moment, the Parsing requests 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants