plone / plone/documentation

ZODB database packing configuration

Open
#756 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

31 needs: help 33 needs: docs 42 lvl: moderate 99 tag: Plone 6.x
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

Just leaving myself a todo here, unless someone else grabs it first.

In http://docs.plone.org/4/en/develop/plone/persistency/database.html#packing-through-the-web, this sentence packs a lot of jargon that needs explaining:

Manual packing can be executed through Zope Control Panel (not Plone control panel) in Zope application server root (not Plone site root) in ZMI.

  • Zope Control Panel vs Plone control panel
  • Zope application server root in ZMI vs Plone site root in ZMI

For a non-Plone insider, these are very obtuse statements. If these things are already defined in some kind of glossary somewhere else, then just linking to the definition would be stellar. Otherwise, we need to add those definitions.

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.

Research direction

Start with the “Packing through the web” section at the linked Plone documentation page and check whether a glossary already defines the Zope and Plone terms. Add concise definitions or links for the Zope Control Panel, Plone control panel, Zope application server root, Plone site root, and ZMI; done means the sentence is understandable to non-Plone users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.