webpack / webpack.js.org

Repository for webpack documentation and more!
https://webpack.js.org
Creative Commons Attribution 4.0 International
2.21k stars 3.31k forks source link

[tba] Add Documentation for migrating to webpack-cli v.4 #2695

Open evenstensberg opened 5 years ago

evenstensberg commented 5 years ago

Feature to document

Webpack-CLI v.4

Author(s)

Even Stensberg, N/A

Additional information

We are releasing a new version of webpack-cli soon, which will mean that some sections of the docs would need to be updated. I'd like to point this out to the documentation team so that you are ready for the change.

At first, the only thing that is needed is to add a how to migrate post at the docs site, which will help users upgrading to the newest cli version. This is because we are removing a lot of flags and it might cause confusion.

Later (Maybe after 2months of LTS), we will gracefully start to migrate the CLI options section to reflect the new CLI.

My proposal is to have 2 posts, one with the old CLI version, one with the new. When webpack 5 is released, we will remove or depreciate those docs and replace it with the new CLI documentation.

I'd like feedback on this to avoid a mass amount of traffic for people asking questions. What would be the best approach?

I'll write the migration post/site, but feedback is good for syncing as well as we know that we aren't making a lot of people angry.

evenstensberg commented 5 years ago

We are releasing an alpha in the end of the year, beta maybe in mid-January and v.4 in february/march

EugeneHlushko commented 5 years ago

webpack 5 specific docs are now living in next branch, the things you want people to migrate should go to migration guide of webpack 5. i really wouldn't wanna see different migration guides for webpack and its cli, thats one tool, having cli in separate repository shouldn't add complexity for users imo.

@sokra thoughts?

sokra commented 5 years ago

I think different migration guides for core and cli made sense, since you can migrate individually. Made even recommend to migrate one at a time.

EugeneHlushko commented 5 years ago

how much content do you think that would be in cli migration @evenstensberg ?

EugeneHlushko commented 5 years ago

My main concern is that user dont usually care about implementation details, and finding two+ migration guides to up v4 to v5 of webpack might trigger some negative tweets and comments (again)

EugeneHlushko commented 5 years ago

if CLI update come out with breaking changes before webpack v5, that would have no negative impact imo. So that users would migrate to new CLI and later that year to webpack v5 when it comes out

evenstensberg commented 5 years ago

@EugeneHlushko one page perhaps, not that much

evenstensberg commented 5 years ago

I'm suggesting this:

- webpack-CLI 4
    - overview
    - flags
        -a
        -b
    - commands
        -a
        -b
    - how to migrate
    - summary