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: migrate documentaion #554

Merged
merged 3 commits into from
Jul 26, 2018
Merged

docs: migrate documentaion #554

merged 3 commits into from
Jul 26, 2018

Conversation

rishabh3112
Copy link
Member

What kind of change does this PR introduce?

docs

Did you add tests for your changes?
no
If relevant, did you update the documentation?
yes

Does this PR introduce a breaking change?

No
Other information
Refers #247

Remove Dead Links in description
Add Installation Guide
@webpack-bot
Copy link

Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon.

MIGRATE.md Outdated
To use `migrate`, run the following command, with the value of `<config>` being a path to an existing webpack configuration file
# webpack-cli migrate

The `webpack-cli migrate` feature eases the transition from version 1 to version 2. `webpack-cli migrate`
Copy link
Contributor

Choose a reason for hiding this comment

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

And from 2 to 4 (version 3 doesn't have breaking changes in terms of configuration)

MIGRATE.md Outdated
# webpack-cli migrate

The `webpack-cli migrate` feature eases the transition from version 1 to version 2. `webpack-cli migrate`
also allows users to switch to the new version of webpack without having to extensively.
Copy link
Contributor

Choose a reason for hiding this comment

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

having to extensively...? Must complete the phrase. Maybe you meant having to do it extensively?

Copy link
Member Author

Choose a reason for hiding this comment

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

My bad 😅.

MIGRATE.md Outdated
To use `webpack-cli migrate`, run the following command, with the value of `<config>` being a path to an existing webpack configuration file
### A. Local Setup
```bash
npx webpack-cli migrate <config>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add also a real example

npx webpacli-cli migrate webpack.config.js

Copy link
Member Author

Choose a reason for hiding this comment

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

See if it's now fine @ematipico after fd7bd9f.

MIGRATE.md Outdated
@@ -150,12 +164,12 @@ module.exports = {

};
```

## Changes Reflected after migration
In summary, we can see the follow changes were made
1. The webpack schema for using loaders has changed
- `loaders` is now `module.rules`
- `query` is now `options`
Copy link
Contributor

Choose a reason for hiding this comment

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

Update as per review by @ematipico
Copy link
Member

@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

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

lgtm here :shipit: , forwarding to @ematipico

@webpack-bot
Copy link

@rishabh3112 Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@ev1stensberg Please review the new changes.

@rishabh3112
Copy link
Member Author

Any changes @ematipico @ev1stensberg ??

@ematipico
Copy link
Contributor

Looks good to me! Thank your very much!

@ematipico ematipico merged commit 618e06b into webpack:master Jul 26, 2018
@rishabh3112 rishabh3112 deleted the patch-1 branch December 25, 2019 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants