Release Plone 6 docs

This is a placeholder issue for the imminent release of Plone 6 docs as being tracked in the GitHub Project Board Plone 6.0 - tasks to final.

Documentation project board: https://github.com/orgs/plone/projects/12/

View current state of Plone 6 documentation: https://6.docs.plone.org/

Organization

Discord server

https://discord.gg/NES2f6dQ
Channel: #training-docs

List the principals and their roles for this issue.

Features and Automation

• Automate testing of docs on each pull request
• https://github.com/plone/documentation/issues/1146
• plone/documentation#1154
• Spell checking
• Link checking
• plone/documentation#1149
• Makefile
• Filter search results by primary section, other?
• plone/documentation#1156
• Page titles show chapter title - sub-chapter title - Plone Documentation
• plone/documentation#1147
• TOC is sticky (always displays while scrolling), and may be collapsed or hidden
• Code can be copied with a click
• Glossary
• Automatically generated index

Which tech stack?

• Sphinx and MyST: Supports reStructuredText and a superset of CommonMark markdown. Used by Training docs.
• Current: hell no.
• Coster: seems to have disappeared.
• Docusaurus: new to developers, lacks features that Sphinx provides OOTB.
• Determined that we shall use MyST and Sphinx for our tech stack.

Branches

• Create 6-dev. This is the feature branch where development for Plone 6 Docs occurs.
• 6 is the main release branch for Plone 6 Docs.
• Merge backend-6 into 6-dev.
• Merge classic-ui into 6-dev.
• Delete volto-frontend as there is nothing of value in it.
• plone/documentation#1148

Structure

• See plone/documentation#1137
• Create a table of contents for each primary item, keeping it as shallow as possible.

Theme

• Select and use a mobile friendly theme, preferably one that unifies Plone, Training, and Volto docs, giving users a coherent experience.
• plone/documentation#1150

Content

• plone/documentation#1151
• Create instructions for how to:
  • write new docs as an Author or Developer
  • contribute to existing docs as a Contributor
• plone/training#991
• plone/documentation#1153

See https://github.com/plone/training/issues/254#issuecomment-991855153

Start with the Plone 6.0 project board and documentation project board, then review the current state at 6.docs.plone.org and the unchecked task plone/documentation#1147. Done means the remaining release documentation work is completed and the Plone 6 docs are released.