docs: update using components page #1176
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhmlau
reviewed
Mar 23, 2018
docs/site/Using-components.md
Outdated
| - Providers of additional [Context values](Context.md) | ||
| LoopBack 4 was built with extensibility in mind and this includes Components, | ||
| which can be allowed to contribute additional artifacts by adding a Mixin | ||
| to your Application class. This doesn't change how a a Component is registered |
docs/site/Using-components.md
Outdated
|
|
||
| - Models | ||
| - [Repositories](Repositories.md) | ||
| **Note:** Always check a components instructions to see if it requires |
There was a problem hiding this comment.
either a component's or a component?
shimks
reviewed
Mar 23, 2018
docs/site/Using-components.md
Outdated
| Components play an important part in the extensibility of LoopBack 4. | ||
| A Component makes it easy for independent developers to contribute additional | ||
| features to LoopBack. Components serve as a vehicle to group extension | ||
| contributions such as Context Bindings and various Artifacts to allow easier |
There was a problem hiding this comment.
Link to Context.md here would be great
docs/site/Using-components.md
Outdated
| In general, components can contribute the following items: | ||
| Components can contribute the following items: | ||
|
|
||
| - [Controllers](Controllers.html) |
docs/site/Using-components.md
Outdated
| Components can contribute the following items: | ||
|
|
||
| - [Controllers](Controllers.html) | ||
| - Providers of additional [Context values](Context.html) |
docs/site/Using-components.md
Outdated
|
|
||
| In the future (before the GA release), components will be able to contribute additional items: | ||
| - [Repositories](Repositories.html) can be contributed by a Component by adding |
docs/site/Using-components.md
Outdated
| In the future (before the GA release), components will be able to contribute additional items: | ||
| - [Repositories](Repositories.html) can be contributed by a Component by adding | ||
| `RepositoryMixin` from `@loopback/repository` to your Application | ||
| - [Booters](Booting-an-Application.html#booters) can be contributed by a Component by adding |
shimks
approved these changes
Mar 23, 2018
raymondfeng
reviewed
Mar 23, 2018
docs/site/Using-components.md
Outdated
| Components play an important part in the extensibility of LoopBack 4. | ||
| A Component makes it easy for independent developers to contribute additional | ||
| features to LoopBack. Components serve as a vehicle to group extension | ||
| contributions such as [Context Bindings](Context.md) and various Artifacts to allow easier |
There was a problem hiding this comment.
Artifacts should be artifacts.
raymondfeng
reviewed
Mar 23, 2018
docs/site/Using-components.md
Outdated
|
|
||
| const app = new Application(); | ||
| ```ts | ||
| import { RestApplication } from "@loopback/rest"; |
There was a problem hiding this comment.
The formatting does not conform to our style. We don't use extra spaces for the {}.
dhmlau
approved these changes
Mar 26, 2018
virkt25
force-pushed
the
docs/using-components
branch
from
de47851 to
d2afe49
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
connected to #988
Same as this PR loopbackio/loopback.io#639 but since we moved docs before it landed, re-creating this.
Checklist
npm testpasses on your machinepackages/cliwere updatedpackages/example-*were updated