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 Application recipes to how-to guides #6106

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

docs: move Application recipes to how-to guides #6106

bajtos opened this issue Aug 13, 2020 · 4 comments · Fixed by #6693
Assignees
Labels

Comments

@bajtos
Copy link
Member

bajtos commented Aug 13, 2020

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

@mrmodise
Copy link
Contributor

Will take this on. Thanks

@mrmodise mrmodise self-assigned this Oct 27, 2020
@mrmodise
Copy link
Contributor

@bajtos on this point:

I think we should have a single page for all of them, we should mention non-core artifacts like DataSources and Repositories too, and include instructions for adding artifacts via project-layout conventions, where the artifacts are picked up and registered by @loopback/boot.

Are you referring to how they're automatically booted to repositories.* datasources.*?

@bajtos
Copy link
Member Author

bajtos commented Nov 5, 2020

@bajtos on this point:

I think we should have a single page for all of them, we should mention non-core artifacts like DataSources and Repositories too, and include instructions for adding artifacts via project-layout conventions, where the artifacts are picked up and registered by @loopback/boot.

Are you referring to how they're automatically booted to repositories.* datasources.*?

I am referring to the following content:

I think we should start with a new page that will contain the existing instructions for adding artifacts manually via TypeScript API (e.g. app.controller).

The second step - and that's what I meant by my comment you quoted - is to enhance this new page to explain how to register artifacts automatically by leveraging @loopback/boot, exactly as you wrote:

they're automatically booted to repositories.* datasources.*?

The idea is to explain all options we provide for registering artifacts - TS API, boot conventions.

@mrmodise
Copy link
Contributor

mrmodise commented Nov 5, 2020

@bajtos will update accordingly. Thanks

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