This post provides an update to the Plone 6 Documentation.
It's been over two months since my last update. That's because we have been working on the docs at the pace of open source on too much Red Bull.
I want to personally thank all the people who contributed, and provided reviews and feedback: @davisagli, @erral, @jensens, @ksuess, @mauritsvanrees, @mrtango, @nileshgulia1, @pbauer, @sneridagh.
This project is under very active development. Contributions are welcome. Read more for how to participate.
Achievements
- Participated in the Plone 6 Documentation Sprint.
- Inserted topmatter key
mystacross all repos.
Documentation
- Released final draft of Install Plone 6 documentation. This is a freaking huge improvement, that implements GNU make and Cookiecutter for installing Plone and its add-ons. This change is so exciting that I tried to explain it to my spouse over dinner.
- A new part for internationalization and localization has been added to the docs. See Create skeleton framework for internationalization and localization.
- Created a replacement for {PLONE_BACKEND_VERSION} in
conf.py, so that we can declare the current version of Plone backend in one place, instead of doing a global find-and-replace. See Allow configuration of source replacements. - Added glossary terms: slate, volto-slate and elementEditor.
- Fix broken links to nvm releases.
- Clarify Support section, removing mention of issues previously mentio…
- Fix dropdown menu new issue , etc
- Change port of "make livehtml" to 8050 to avoid conflicts with other apps running
- Remove all instances of "Plone" from page titles
- Promote the Plone 6 Upgrade Guide to the top level navigation
- Mrtango update responsive images settings docs
- Fix dropdown menu (repository, "open issue", "suggest edit")
Volto
- Add volto-slate upgrade guide
- volto-slate documentation
aria-*attributes are now parsed correctly by jsx-lexer 2.0- Fix broken links to nvm releases.
- Generic Setup ->
GenericSetup
plone.restapi
- Fix Google redirect and hyphenation of word
- Reorganize navigation. Now Endpoints, Usage, and Contributing are grouped into subfolders, making it easier to find what you need.
- Add portrait to toctree
plone.volto
- Updated home page content for https://6.demo.plone.org/
Training
- Update FAQ block type code example #626
- Replace plonedemo.kitconcept.com/en with 6.dev-docs.plone.org #620
6.demo.plone.org
Project Board item counts
Here are our current counts on the Release Plone 6 docs project board.
| Status | documentation | volto | plone.restapi | plone.api | training | training.plone.org | 6.demo.plone.org | plone.staticresources | plone.volot | total |
|---|---|---|---|---|---|---|---|---|---|---|
| New | 18 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 19 |
| Todo | 29 | 10 | 2 | 2 | 1 | 2 | 0 | 0 | 0 | 46 |
| In Progress | 6 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 8 |
| Approved | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
| Done | 83 | 50 | 28 | 11 | 15 | 0 | 1 | 1 | 3 | 192 |
| Total | 136 | 60 | 32 | 13 | 17 | 3 | 1 | 1 | 3 | 266 |
A Burn up / CFD graph shows our progress since Jan 15, 2022. Note the increased pace of work being performed since the Documentation Sprint, and as we head into PloneConf 2022.
https://github.com/orgs/plone/projects/12/insights/1
Next steps
- Complete review of the PR Add old upgrade guide, update it and integrate with new chapters.
- Complete review of the PR classic-ui/view and layers.
- Installation from packages: All-In-One-Installer
- Automatically update submodules when other repos push to
master - Using the converted 5.2 documentation MyST files, fill in the remaining gaps in Plone 6 documentation.
- Remove Google Analytics tags, and replace with, or install, Matomo for analytics for Training and plone.restapi
- PloneConf Plone 6 Documentation Sprint
How to contribute
- We have many open issues that need your help.
- Join the "Plone Docs" Netlify Open Source Team. Please ask on Discord in the
#documentationchannel to become a member of the team.
Previous updates
- Plone 6 Documentation Update 2022-07-13 - Install Plone 6
- Plone 6 Documentation Update 2022-04-30 - plone.api incorporated
- Plone 6 Documentation Update 2022-03-29 - plone.restapi incorporated
- Plone 6 Documentation Update 2022-02-21
- Plone 6 Documentation adds Volto frontend docs, automatic deployments
- Plone 6 Documentation ready for contributions
