-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[Spike][Docs] reorganize connector reference into reference, how-to guides, and tutorials #6061
Conversation
The plan LGTM, awesome. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the proposal at high level 👏🏻
Let's improve the content users will see when this PR is deployed to loopback.io, see my comments below.
docs/site/DataSources.md
Outdated
@@ -81,3 +81,17 @@ Attach the newly created datasource to the app by calling `app.dataSource()`. | |||
The `app.datasource()` method is available only on application classes | |||
with `RepositoryMixin` applied. | |||
" %} | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the content above (e.g. "Creating a datasource at runtime") should be eventually moved to "How-to guides" and/or the new page "Configuring-datasource.md" you are creating? I guess that's out of scope of this PR, just want to mention it.
7c202b9
to
88c6536
Compare
88c6536
to
97c6d9f
Compare
Closes #5961
Suggestion
Currently, our connector reference sits under "Reference Guides". It's hard to find a specific connector page as the path might be
Reference Guides/Connector reference/Database Connector/MySQL connector/Tutorial
.Here is a proposal of how to reorganize them into the four quadrants
REFERENCE GUIDES
keep the current connector reference as is.
BEHIND THE SCENES
add a section or a subpage under "Behind the scene/Datasource" that talk about:
HOW-TOS
add a page "Configuring DataSource"(or a better name) under "How-tos/Access Database" that talks about common connector configurations such as:
Varchar, Boolean -> Tinyint
Bigint -> int, Text -> String
objectId
, and readers should check the corresponding connector pages.TUTORIALS
Add a page "Connect to back-end tutorial" under "Tutorials" that: