plone / plone/documentation

Purge empty pages and todos

Open
#1,882 14 comments 1 reaction 1 assignee View on GitHub

@stevepiercy is already working on this.

Since Mar 2, 2025.

01 type: bug
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

We've had empty pages and TODOs for over three years in Plone 6 Documentation, especially under the Backend section, but also under Deployment, Classic UI, Volto, and Contributing. The Plone 6.1 milestone has only 17% of its issues completed after the release of Plone 6.1. The lack of current and accurate documentation for Plone 6 is the single greatest barrier to entry for all audiences. This reflects extremely poorly upon Plone, where documentation is perceived as less than an afterthought.

The following list of URLs are affected.

Purge empty pages. A page is empty when either it has no content or its only content is a TODO. If there is no existing issue for the page, then create a new issue.

All other pages in the list have content with at least one TODO. For these pages, preserve the TODO. If the TODO does not contain a link to an existing issue, then create a new issue and add its URL to the TODO, except for obsolete TODOs, such as Upgrading Plone 4.x to 5.0.

Configure conf.py to hide the display of TODOs, changing code from the following...

https://github.com/plone/documentation/blob/b4462a84bac18a56ea8a37390cd87b027e8b85bd/docs/conf.py#L381-L385

...to the following.

# -- Options for sphinx.ext.todo -----------------------

# See http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
todo_include_todos = False
todo_emit_warnings = True
todo_link_only = True

Ref: https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration

@plone/volto-team @plone/restapi-team @plone/ci-team @plone/classicui-team @plone/marketing-communications @plone/documentation-team @plone/developers

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.