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

doc(plugins): add ChunksWebpackPlugin #3771

Closed
wants to merge 40 commits into from

Conversation

yoriiis
Copy link
Contributor

@yoriiis yoriiis commented Jun 4, 2020

This PR adds the ChunksWebpackPlugin to the plugins documentation page.
A dedicated page with instructions for use is also added.

@vercel
Copy link

vercel bot commented Jun 4, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/dae87rdvm
✅ Preview: https://webpack-js-org-git-fork-yoriiis-add-chunks-webpack-plugin.webpack-docs.now.sh

Copy link
Member

@EugeneHlushko EugeneHlushko left a comment

Choose a reason for hiding this comment

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

This is great addition, although it requires some changes, you can applu the suggested changes and clarify the questions or if suggestions dont look good we can discuss them individually

src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
var to const

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:10 Inactive
var to const

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:10 Inactive
Update doc

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:10 Inactive
yoriiis and others added 2 commits June 5, 2020 12:11
var to const

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
var to const

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
Update doc

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:14 Inactive
Update doc

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:15 Inactive
Update doc

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:15 Inactive
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:16 Inactive
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:17 Inactive
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 5, 2020 10:17 Inactive
@yoriiis
Copy link
Contributor Author

yoriiis commented Jun 5, 2020

Thank you @EugeneHlushko for your comments 👍.
I updated the doc with several of your suggestions and a few other commits (I don't know if I could close these threads, sorry if not).

I have a few questions about open threads.

Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
Co-authored-by: James George <jamesgeorge998001@gmail.com>
@vercel vercel bot temporarily deployed to Preview June 7, 2020 14:30 Inactive
@vercel vercel bot temporarily deployed to Preview June 7, 2020 14:32 Inactive
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@yoriiis
Copy link
Contributor Author

yoriiis commented Jun 7, 2020

Thanks @EugeneHlushko and @jamesgeorge007, everything is up to date.

Co-authored-by: Fernando Montoya <montogeek@gmail.com>
Copy link
Member

@EugeneHlushko EugeneHlushko left a comment

Choose a reason for hiding this comment

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

all looks good i just spotted last minor corrections, if we will merge them in and see if CI still passes then merge it into master

src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
src/content/plugins/chunks-webpack-plugin.md Outdated Show resolved Hide resolved
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
@alexander-akait
Copy link
Member

alexander-akait commented Jun 10, 2020

I think we don't merge it, better to put it here https://github.com/webpack/webpack.js.org/blob/master/repositories/plugins.json and imporve original README of the plugin, it is not official plugin and can be removed/broken/vulnerable in any time without support from the official team

@yoriiis
Copy link
Contributor Author

yoriiis commented Jun 10, 2020

@EugeneHlushko Any ideas why the CI job Lint and Build fails for the last commit? It is only minor text corrections and I don't understand the error report.

@alexander-akait
Copy link
Member

Why we should not merge it and put it in list of plugins:

We should avoid adding pages for non official plugins, only include them https://github.com/webpack/webpack.js.org/blob/master/repositories/plugins.json

Also we should highlight official plugins, and show vendor plugins as nonofficial, I get very often issues in webpack/webpack-contrib orgs related to non official loaders/plugins, developers think that they see it in the official documentation, we should help them with any problems, but we can't do it, so we should solve this problem

I can open an issue about it and we will continue discussion there

/cc @EugeneHlushko

@alexander-akait
Copy link
Member

@yoriiis I am not against your plugin in docs, I just want to reconsider our approach to documentation for loaders/plugins

@yoriiis
Copy link
Contributor Author

yoriiis commented Jun 10, 2020

@evilebottnawi I understand, although I think it could help webpack users.

For compatibility with webpack 5, I think there are other plugins not yet compatible right?
Noted for the other issues you mentioned, I will update the plugin soon.

For the differences in the README files, we have made several changes with the help of @EugeneHlushko to improve the documentation, thanks for that. I will update all of these changes in the original README file, for sure.

If I can help you in the official team, it's with pleasure.

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.

5 participants