Javascript in add-ons. Explain the Plone 6 way.
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
The upgrade guide mentions already this topic: https://6.docs.plone.org/backend/upgrading/version-specific-migration/upgrade-to-60.html#mockup-and-resource-registry-redone
A more detailed "How To" would be helpful. With code and screenshots and examples of add-ons that do it the recommended way.
Placeholder is already there: https://6.docs.plone.org/classic-ui/static-resources.html
Suggested outline
- What's the purpose of patterns?
- Show me an example implementation. In which files is it applied? What does the code look like?
- How do I write a pattern? plonecli, bobtemplates, other?
- How do I register resources, such as JavaScript, images, and CSS?
- Do I have to minify or does Plone minify?
- Where does jQuery fit into patterns?
- Does module federation affect me?
- Where would should this chapter be located? In
classic-uiorclassic-ui/theming?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin with the upgrade-to-6.0 guide and the existing classic-ui/static-resources.html placeholder. Use the suggested outline to organize a How To covering patterns, resource registration, jQuery, minification, module federation, and add-on examples, with code and screenshots. Done means the relevant classic-ui documentation location is chosen and the chapter answers the listed questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100