Plone 6 Documentation Update 2024-05-08 - Plone Sphinx Theme released

Documentation
, ,
1

I have several important announcements for all contributors to Plone 6 Documentation.

First I want to personally thank all the people who have contributed since I last gave an update about a year ago, and provided reviews and feedback: @07tAnYa, @Akshat2Jain, @cekk, @davisagli, @ericof, @erral, @fredvd, @gforcada, @gogobd, @hrittik, @ichim-david, @jensens, @justdaksh, @ksuess, @margaridasp, @mauritsvanrees, @mrtango, @petschki, @polyester, @rber474, @sneridagh, @thet, @tiberiuichim, @toalba, @Vivek-04022001. Apologies to anyone I missed.

This project is under very active development. Contributions are welcome. Read more for how to participate. Several members of the Documentation Team will be participating at the Beethoven Sprint May 13-17, both in person and remotely. I hope to see you all participate.

Plone Sphinx Theme 0.0.2 released

plone-sphinx-theme is a Sphinx theme for Plone 6 Documentation, Plone Conference Training, and documentation of various Plone packages.

In the coming weeks, we'll work on open issues, including applying the new theme to Plone projects.

In the meanwhile, you can take a sneak peek at the Plone Sphinx Theme's documentation hosted at a temporary URL until we configure DNS.

Netlify going away

We use Netlify for preview builds of documentation. This saves the effort of checking out the pull request branch, and building the docs locally. Unfortunately Netlify supports only Python 3.8, and the parent theme for Plone Sphinx Theme requires Python 3.9 or greater.

We are considering a migration to Cloudflare Pages as a replacement.

If you have experience with Cloudflare Pages or know if a similar free service, please make a comment in the issue tracker.

Training

It's that time of the year to take a snapshot of trainings presented at PloneConf 2023 by creating a new branch 2023 from main in the Training repository, and deploy the 2023 branch to a new host name of 2023.training.plone.org. This will also prepare the main branch for training authors and contributors to update documentation for PloneConf 2024 in Brasilia.

We will do this during the Beethoven Sprint, May 13-17.

The URL of https://training.plone.org/ will always and forever be deployed from the main branch.

Any links to the archived trainings must be updated by prefixing them with 2023. and updating Intersphinx references accordingly. Links that go to obsolete trainings will result in a 404 not found response, for example, https://training.plone.org/sad-trombone.

To update links in your documentation's Intersphinx setting in conf.py:

intersphinx_mapping = {
    "training": ("https://training.plone.org/", None),
    "training-2022": ("https://2022.training.plone.org/", None),  # Archived trainings
    "training-2023": ("https://2023.training.plone.org/", None),  # Archived trainings
}

And in your MyST markdown, you would use a reference with the new Intersphinx mapping.

For TTW configuration, see {doc}`training-2023:mastering-plone-5/configuring_customizing`.

Documentation Team meetings

Due to low participation, I decided to suspend Documentation Team meetings. If sufficient interest resurfaces, either for a specific topic or a regularly scheduled meeting, then I'll schedule them.

Meanwhile, consider participating in other Plone teams. I currently participate in the teams for Volto, Classic UI, Training, and Steering Circle.

Other major achievements

Most of the efforts focused on improving the Plone developer experience, from how to contribute, to how to install Plone—whether for a project, development, or contributing—how to manage and deploy projects, and how to develop Plone frontends, either Classic UI or Volto.

Documentation

An impressive 278 documentation issues and pull requests were closed in the last year. Here are some highlights.

Volto

Training

Project Board item counts

Here are our current counts on the Release Plone 6 docs project board.

Repository New Todo In Progress Approved Done Total
documentation 5 61 17 1 278 362
volto 5 25 3 0 204 237
training 1 8 1 0 68 78
plone.restapi 0 1 1 0 57 59
plone.api 0 2 0 0 17 19
plone-sphinx-theme 0 4 1 0 1 6
training.plone.org 0 0 0 0 4 4
plone.volto 0 0 0 0 3 3
plone-backend 0 2 0 0 0 2
buildout.coredev 0 1 0 0 0 1
Products.CMFPlone 0 1 0 0 0 1
mockup 0 1 0 0 0 1
demo.plone.org 0 0 0 0 1 1
plone.app.dexterity 0 0 1 0 0 1
plone.staticresources 0 0 0 0 1 1
total 11 106 24 1 634 776

A Burn up / CFD graph shows our progress since Jan 15, 2022. The pace of work being completed is fairly consistent.

https://github.com/orgs/plone/projects/12/insights/1

Burn up / CFD graph since Jan 15, 2022
Burn up / CFD graph since Jan 15, 20221203Ă—634 48.9 KB

Next steps

How to contribute

Previous updates

7 Likes