This post provides an update to the Plone 6 Documentation.
First I want to personally thank @sneridagh, @ksuess, @tiberiuichim, @nileshgulia1, and all the other people who contributed, and provided reviews and feedback.
This project is under very active development. Contributions are welcome. Read more for how to participate.
Achievements
-
Set default branch to
plone/documentation@6-dev. - Added templates for new issues, new pull requests, and a chooser that directs visitors to the Community for support or to Discord for conversation.
- Created a standalone MyST build for the Volto docs.
- Development on Volto docs now takes place on
plone/volto@masterbranch. - Automatic deployments of pull requests as previews on Netlify for separate Volto docs. When a pull request is opened against
plone/volto@master, a preview build will show up in the list of checks in the pull request. Each preview has a unique hash in its URL. - Added breadcrumbs and other improvements to search results.
- Removed obsolete Volto documentation and reorganized some pages.
- Converted admonition syntax from Markdown to MyST in Volto.
Project Board item counts
Since my last update on February 3, we closed or merged 16 items in plone/documentation and 16 items in plone/volto.
Here are our current counts on the Release Plone 6 docs project board.
| documentation | volto | plone.restapi | total | |
|---|---|---|---|---|
| Todo | 17 | 5 | 0 | 22 |
| In Progress | 2 | 0 | 1 | 3 |
| Closed | 21 | 17 | 0 | 38 |
| Total | 40 | 22 | 1 | 63 |
Next steps
-
@stevepiercy will herd cats to integrate
plone.restapidocs into the main Plone documentation. -
@ksuess will lead the effort to integrate
plone.apidocs into the main Plone documentation.
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.