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

Official Module Federation Documentation? #20

Closed
Domiii opened this issue Oct 17, 2020 · 5 comments
Closed

Official Module Federation Documentation? #20

Domiii opened this issue Oct 17, 2020 · 5 comments

Comments

@Domiii
Copy link

Domiii commented Oct 17, 2020

Currently, when googling for modulefederationplugin documentation, only guides and blog articles pop up, but there is no documentation on all parameters, which makes me nervous when considering using it in a project.

What I found:

All this is really really great! At the same time, when it comes down to the nitty gritty, I'd love to have some proper documentation to better understand what I am doing with all these many many parameters that I can tune :/

Any plans to explain all the things?

E.g. what does singleton do? Does it error out if another version of the module is found? Etc...

@Domiii Domiii changed the title There is no proper documentation for module-federation Official Module Federation Documentation? Oct 17, 2020
@lili21
Copy link

lili21 commented Nov 26, 2020

lack of docs is the biggest issue of the feature, I think. make it hard to use, and hard to understand. I would love to help.

@lili21
Copy link

lili21 commented Nov 29, 2020

webpack/webpack.js.org#3757

@Domiii
Copy link
Author

Domiii commented Dec 3, 2020

After looking at this repo again, it looks more like the ad for a 45$ book than an attempt to produce open source documentation? I'm not arguing against open source developers getting paid for their hard work, just considering that this is probably the wrong place to ask for better API documentation?

@Domiii
Copy link
Author

Domiii commented Jun 9, 2021

I guess I know now why I thought that this would be the right place to ask. It is because the first thing it says in the README is:

"A website documenting Webpack 5 Module Federation."

That is probably why I was expecting more that just getting shutdown here.

For anyone still ending up here: The real discussion is happening over at webpack/webpack.js.org#4283.

Also, thanks @ScriptedAlchemy for the great work on WMF. Been using it for a while now. Looking forward to that documentation still though :)

@ScriptedAlchemy
Copy link
Member

Sorry for closing out. The site serves to aggregate stuff.

Documentation is scarce and pull requesting the webpack docs is a strenuous process.

I'll try to write something on this site that offers more docs, writing stuff isn't my strong suit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants