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

Release - Document v4 (Migration Guide and Feature Additions) #1706

Open
TheLarkInn opened this Issue Nov 17, 2017 · 23 comments

Comments

Projects
None yet
10 participants
@TheLarkInn
Member

TheLarkInn commented Nov 17, 2017

Hey docs team and all of our beloved contributors!!!!

We are getting close to merge webpack/webpack#next (v4) into master soon and we have drafted a WIP change log and this means we can start laying the ground work and documentation for our migration guide and other changes!

Listed is the link to the changelog:

https://github.com/webpack/webpack/wiki/Changelog-WIP

I'd give you ownership to break up the work however you see fit! Let me know if the core team can help in any way!!!

🔥🔥Lots of exciting changes!🔥🔥

@skipjack skipjack changed the title from webpack v4 migration guide and feature additions to Release - Document v4 (Migration Guide and Feature Additions) Nov 18, 2017

@reergymerej

This comment has been minimized.

Member

reergymerej commented Jan 14, 2018

I've got a PR in core that modifies a new feature (sideEffects in package.json) and I'd like to make the sister change in the docs. Can anyone point me in the right direction?

@skipjack

This comment has been minimized.

Collaborator

skipjack commented Jan 14, 2018

Hmmm, maybe in the API section somewhere? Also target your PR to the next branch.

@reergymerej

This comment has been minimized.

Member

reergymerej commented Jan 14, 2018

Thanks, @skipjack. I searched the next branch and didn't see anything. I may be the first to add it.

@skipjack

This comment has been minimized.

Collaborator

skipjack commented Jan 23, 2018

From #1795...

Create an upgrade path section with clearly defined, individual pages:

  • Upgrade from v1 to v2
  • Upgrade from v2 to v3
  • Upgrade from v3 to v4

Each page should include any script helpers, and examples particular to it's version of the upgrade.

@skipjack

This comment has been minimized.

Collaborator

skipjack commented Jan 23, 2018

I like the note from from #1795 though in terms of actual wording/implementation, I think we should create a "Migrating" group under Guides and title the articles simply v1 - v2, v2 - v3, etc. (or 1.x.x to 2.x.x).

@TheLarkInn

This comment has been minimized.

Member

TheLarkInn commented Jan 25, 2018

Here is the first issue with a set of migration diffs. I think this is something we can run with?

#1706

@TheLarkInn

This comment has been minimized.

Member

TheLarkInn commented Feb 5, 2018

@skipjack, I've been starting to make a bunch of videos that are going to hopefully be embeddable into our documentation. I'm not sure where I can start to organize them. Would it work best to dump into a standalone issue?

@TheLarkInn

This comment has been minimized.

Member

TheLarkInn commented Feb 6, 2018

I like the note from from #1795 though in terms of actual wording/implementation, I think we should create a "Migrating" group under Guides and title the articles simply v1 - v2, v2 - v3, etc. (or 1.x.x to 2.x.x).

Has this already landed in next branch? If not, I will create an issue so that first time contributor can tackle just this work (creating the group).

@skipjack

This comment has been minimized.

Collaborator

skipjack commented Feb 23, 2018

@jeremenichelli @TheLarkInn here's the start of the list of todos as I understand it:

  • Rewrite plugin API section according to the new tapable interface and hooks (#1754)
  • Finish hook descriptions and see if anything else is missing re plugin interface
  • CommonsChunkPlugin removal and new splitChunks page (#1863)
  • Document minimize configuration opts
  • Write migration guide and create Migration group within Guides
  • Document new ProfilingPlugin (#1830)
  • Custom hash function (#1761)

@EugeneHlushko can you share some of the things you tackled? Once we get those, I'll move this list to the top-level comment so it's more visible and we can continue updating it.

@EugeneHlushko

This comment has been minimized.

Member

EugeneHlushko commented Feb 23, 2018

  1. Profiling plugin you've referenced #1830
  2. info-verbosity #1817 isnt really v4 its just a feature that landed already
  3. nonce #1833 also isnt v4 but wasnt documented and is not in a great state as having dynamic nonce requires re-compilation and complex ssr setup, but at least it documents what it currently does.
  4. custom hash function documented #1761
@skipjack

This comment has been minimized.

Collaborator

skipjack commented Feb 23, 2018

Perfect, thanks @EugeneHlushko. Let us / @jeremenichelli know if there's anything else you notice that is missing from this list (whether it's already landed in next or needs to).

@jeremenichelli so you're thinking about closing this ticket and starting a new issue or pr that lists these out at the top? I think that makes sense to keep things clean.

@jeremenichelli

This comment has been minimized.

Member

jeremenichelli commented Feb 23, 2018

No closing it @skipjack, leave this one for Migration, and creating one to track all v4 Docs. Just redirecting and gardening directions so they don't derail and it's easier to track progress on docs 😊

@skipjack

This comment has been minimized.

Collaborator

skipjack commented Feb 23, 2018

Makes sense, then maybe we re-title and tag it so it's clear it's specific to writing the migration guide.

@jeremenichelli

This comment has been minimized.

Member

jeremenichelli commented Feb 23, 2018

Yeap, sounds good.

@nikunjg

This comment has been minimized.

nikunjg commented Mar 8, 2018

any updates in providing webpack 4 documentation

@jeremenichelli

This comment has been minimized.

Member

jeremenichelli commented Mar 8, 2018

@nikunjg we are working on it 😊 you can see the progress in the conversations in the Issues and Pull requests and in the next branch where we are merging all the changes.

Sadly, we don't have the dates, but we hope to have it as soon as possible. Let us know if you would like to collaborate.

@nikunjg

This comment has been minimized.

nikunjg commented Mar 8, 2018

@jeremenichelli, that means documentation provided in the link https://webpack.js.org/guides/asset-management/ is for webpack 3. if yes, Should I use webpack 3 then?

@jeremenichelli

This comment has been minimized.

Member

jeremenichelli commented Mar 8, 2018

Particularly for that section, I don't any issues with webpack v4 besides possible issues in the loaders mention there. I suggest you to go to the loader repository and see if it has been updated to work with v4.

@the-spyke

This comment has been minimized.

the-spyke commented Apr 4, 2018

Is there documentation for optimization section?

@the-spyke

This comment has been minimized.

the-spyke commented Apr 5, 2018

I'm upgrading an app to the 4.5 version from 3.11, and after a day I can say that a big chunk of the documentation is outdated or missing. Looks like #0CJS turned out to be #0DJS.
¯\_(ツ)_/¯

[update] Now rereading all blog posts: some good info is there.

@xyzdata

This comment has been minimized.

@stephan-v

This comment has been minimized.

stephan-v commented May 11, 2018

No wonder you have such a bad reputation if you keep pulling stunts like these.

@ajhyndman

This comment has been minimized.

ajhyndman commented May 29, 2018

@the-spyke Documentation for the options available for the optimization field seems to be available under the SplitChunksPlugin, here:

https://webpack.js.org/plugins/split-chunks-plugin/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment