Skip to content

Improve Plugin Documentation #1254

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

Merged
merged 5 commits into from
May 29, 2017
Merged

Improve Plugin Documentation #1254

merged 5 commits into from
May 29, 2017

Conversation

skipjack
Copy link
Collaborator

@skipjack skipjack commented May 27, 2017

Add lead-in descriptions (#1161) and clean up content. Most of these changes were to the local plugin docs in this repo but I also opened a few prs on external repos where necessary like this one. Also adding documentation for #815.

Resolves #1161
Resolves #815

@skipjack skipjack requested review from simon04 and bebraw May 27, 2017 21:29
@skipjack
Copy link
Collaborator Author

@bebraw @simon04 can one of you give this a quick skim? Should be pretty much good to go.

---

?> Review this content
The `LoaderOptionsPlugin` is unlike other plugins in that it is built for migration from webpack version 1 to version 2. In webpack v2, the schema for a `webpack.config.js` became stricter; no longer open for extension by other loaders and plugins. The intention is that you pass `options` directly to loaders and plugins (i.e. `options` are __not__ global or shared.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing ).


In the future this plugin may be removed.
W> This plugin may be removed in the future as it only exists for migration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say will. Stronger incentive to move.


## Examples
Here's a simple example of how this plugin might be used:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would drop "simple" as that's a filler word.

@skipjack skipjack merged commit 71f7703 into master May 29, 2017
@skipjack skipjack deleted the improve-plugin-docs branch May 29, 2017 15:33
@skipjack
Copy link
Collaborator Author

Merged, but again please ping me if anything here needs tweaking.

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 this pull request may close these issues.

2 participants