Module Federation Documentation.

[thet]

No description provided.

[netlify]

✅ Deploy Preview for 6-docs-plone-org ready!

Name	Link
🔨 Latest commit	cfe78b0
🔍 Latest deploy log	https://app.netlify.com/sites/6-docs-plone-org/deploys/662f5108579a32000792d0c9
😎 Deploy Preview	https://deploy-preview-1253--6-docs-plone-org.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[reinhardt]

See also https://github.com/Patternslib/Patterns/blob/master/docs/developer/module-federation.md

[reinhardt]

Thanks for the suggestion! I'm actually starting to doubt whether it makes sense to have a separate chapter on module federation. With plone/bobtemplates.plone#507 you will get it for free in the future when creating a pattern with plonecli/bobtemplates. There should probably be documentation how to customize a pattern, including a sentence that mentions module federation, but maybe not a full explanation.

[ksuess]

Thanks for the suggestion! I'm actually starting to doubt whether it makes sense to have a separate chapter on module federation. With plone/bobtemplates.plone#507 you will get it for free in the future when creating a pattern with plonecli/bobtemplates. There should probably be documentation how to customize a pattern, including a sentence that mentions module federation, but maybe not a full explanation.

Module federation is independent of Mockup patterns, but is the way JS bundles are composed the Plone 6 way, am I correct?

So, will this draft also be an instruction for "I have a Plone 5 add-on with some arbitrary Javascript code, not necessary a Mockup pattern, and I want to know, how I to lift this Plone 5 add-on to Plone 6"?

[reinhardt]

Yes and no... Probably @thet can explain that better?

[stevepiercy]

In this review, I cover the entire document to date.

It's looking good. Thank you!

[stevepiercy]

One minor fix, and this is good to go.

If there are more things that need to be added, I would suggest adding an outline of those items at the least. Then we can fill in details.

Thank you!

[stevepiercy]

Please move the above part after the content for this section, after "Add-ons can add bundles called "remotes" which are initialized for module federation by the host bundle." and before "## Using module federation". We need an introduction before showing a link to an external site.

[ksuess]

Please include "classic-ui/module-federation" in naviagation.

[ksuess]

I have questions. This is how to get the custom pattern (js pattern code) of my add-on up and running. What about other js code. For example old jquery code. Would it maybe make sense to provide information about this traditional stuff also here, or would that go in another chapter?

[thet]

@ksuess that doc here was not really meant to get you started from scratch. It's more about how to configure module federation.
But I agree - we need a how to start document, also a bobtemplates integration (started but here: plone/bobtemplates.plone#507 but not finished yet).
Not sure if these docs should be extended for a full start-from-scratch, or should it?

Btw. the https://github.com/Patternslib/pat-PATTERN_TEMPLATE is IMO a good patterns generator and a perfect starting point.
However, it does not provide a plone integration (registering of resources, etc) - this is what the bobtemplates PR‌ is about.

@petschki I added some fixes for the recent webpack.mf.js changes plus some references to full, working examples.

Btw. I'm on vacation the next two weeks, so don't expect any updates from me.. :)

[stevepiercy]

A couple of English syntax improvements, using shorter sentences, and an optional suggestion for link syntax.

[stevepiercy]

When a term is first introduced on a page, we must either define it or provide a reference to its meaning, either with a Glossary entry or a link to an external website where it is defined. Please amend the link to whatever is preferred.

I also noticed that I overlooked that Mockup lacks a definition or reference when it is was first introduced, so that should be done above as well.

Suggested change

	Potentially these are the ones from Patternslib, Mockup and your own dependencies.
	Potentially these are the ones from [Patternslib](https://github.com/Patternslib/pat-PATTERN_TEMPLATE), Mockup, and your own dependencies.

[stevepiercy]

This suggestion is optional. In general, I prefer to keep the URL next to its label as in [label](https://url.com/path), instead of this reference style. They both render the same for readers. But for authors it has advantages:

• Simpler syntax.
• It associates the label with the link directly, instead of requiring the author to scroll down to reference it.
• When a link is broken, linkcheck and linkcheckbroken refer to the line of the label, not the URL, in the error, so you would see something like classic-ui/module-federation: line 31) broken https://pypi.org/project/plonecli-404/ - 404 Client Error: Not Found for url: https://pypi.org/project/plonecli-404/
• Preferred by most authors.

Perhaps that style was carried over from the dogma of keeping line lengths to 80 characters. In narrative documentation, line length does not matter. It is not code and most editors can soft wrap long lines of text these days.

[ksuess]

@ksuess that doc here was not really meant to get you started from scratch. It's more about how to configure module federation. But I agree - we need a how to start document, also a bobtemplates integration (started but here: plone/bobtemplates.plone#507 but not finished yet). Not sure if these docs should be extended for a full start-from-scratch, or should it?

Btw. the https://github.com/Patternslib/pat-PATTERN_TEMPLATE is IMO a good patterns generator and a perfect starting point. However, it does not provide a plone integration (registering of resources, etc) - this is what the bobtemplates PR‌ is about.

@petschki I added some fixes for the recent webpack.mf.js changes plus some references to full, working examples.

Btw. I'm on vacation the next two weeks, so don't expect any updates from me.. :)

Ah, OK, then this is chapter is focused on Module Federation. And it assumes knowledge on how to work with static resources in general, how to add static resources (js, css) to a custom theme (based on Barceloneta or not).

Then the questions of a theme / add-on creator should be answered in a general chapter on static resources, which indeed already exists! After your comment, I found it: https://6.dev-docs.plone.org/classic-ui/theming/from-scratch.html#theme . The chapter title "Plone Classic UI Theming based on Barceloneta" should probable read something like "Plone Classic UI Theming independent of Barceloneta".
I'll mark my former imaginary theme creator questions as resolved and find a way to add them to https://6.dev-docs.plone.org/classic-ui/theming/from-scratch.html#theme if appropriate.

[jensens]

I read the instructions and I am a bit clueless. Could we have some very minimal but complete and working example?

[MrTango]

Then the questions of a theme / add-on creator should be answered in a general chapter on static resources, which indeed already exists! After your comment, I found it: https://6.dev-docs.plone.org/classic-ui/theming/from-scratch.html#theme . The chapter title "Plone Classic UI Theming based on Barceloneta" should probable read something like "Plone Classic UI Theming independent of Barceloneta".

from-scratch here stays for no Diazo, only templates overrides vs diazo.
In the docs there is not much for theming sofar, but the training has already quite some infos, but they need an update before the conference.

like in the training: Create a Theme from scratch vs Create a theme based on Diazo

[stevepiercy]

@thet @reinhardt @ksuess @jensens @MrTango I updated the base branch and tidied up the MyST and English grammar and syntax. I'd appreciate your collaboration to get this PR finished and deployed to the documentation. Thank you!

[jensens]

Overall this looks good, what is missing?