This post provides an update to the Plone 6 Documentation.
First I want to personally thank @ksuess, @tiberiuichim, @sneridagh, @ericof, @nileshgulia1, and all the other people who contributed, and provided reviews and feedback to help push this baby out.
This project is under very active development. Contributions are welcome. Read more for how to participate.
Achievements
- Automatic deployments when pull requests are merged, or commits are made to,
plone/documentation@6-dev. The site is hosted at: https://6.dev-docs.plone.org/ - Automatic deployments of pull requests as previews on Netlify. When a pull request is opened against
plone/documentation@6-dev, a preview build will show up in the list of checks in the pull request. Each preview has a unique hash in its URL. - We now have a "Plone Docs" Netlify Open Source Team. Please ask on Discord in the
#documentationchannel to become a member of the team. - Volto docs are now imported into the Plone 6 Documentation. Take a look: Frontend — Plone Documentation v6.0-dev
- Created a detailed contributing guide, including how to setup the environment and build the docs with only four shell commands. Don't believe me? Try it yourself! Building and Checking the Quality of Documentation – Contributing to Plone Documentation — Plone Documentation v6.0-dev
Next steps
- We have many open issues that need your expertise.
- Create a standalone MyST build for the Volto docs. This will allow Volto developers to continue documenting things as before, while the Documentation Team converts existing Volto docs to MyST syntax and extensions.