docs(v2): document plugins and lifecycle APIs #1724
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
20 tasks
|
Deploy preview for docusaurus-2 ready! Built with commit 8caa20a |
|
Deploy preview for docusaurus-preview ready! Built with commit 8caa20a |
yangshun
suggested changes
Sep 13, 2019
website/docs/advanced-plugins.md
Outdated
|
|
||
| A plugin is a module which exports a function that takes two parameters and returns an object. | ||
|
|
||
| We need to specify for our plugin: |
There was a problem hiding this comment.
These are not the only things a plugin is for. Only content plugins do these, the rest don't have to do so. I think saying this can be misleading for people unfamiliar to the concept of plugins.
website/docs/advanced-plugins.md
Outdated
|
|
||
| And `options` are optionally the [second parameter when the plugins are used](/docs/using-plugins#configuring-plugins). | ||
|
|
||
| ### Paths to watch |
There was a problem hiding this comment.
I wonder why we only mention paths to watch here? Is this supposed to be a tutorial or some sort?
|
@wgao19 Will you follow up on the PR? Or I could take over too. |
|
Hi @yangshun yes plz help take over this. I am still pretty held up by my work stuff recently :( |
yangshun
force-pushed
the
wgao19/docs-lifecycle-apis
branch
from
fdde3df
to
3ec8e90
Compare
yangshun
changed the title
yangshun
approved these changes
Oct 8, 2019
|
@endiliey wanna have a go at reviewing it? |
endiliey
reviewed
Oct 8, 2019
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.
Motivation
Addressing #1640, refine docs to lifecycle APIs. Might combine to refine docs on advanced guides on plugins as well.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
NA
Related PRs
NA