plone / plone/documentation

classic-ui: document global utils

Open
#1,202 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

99 tag: classic-ui 99 tag: Plone 6.x
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

Document all global utils and global variables in templates.

The global variables in templates should be documented in classic-ui.
The rest of global utils should be documented in backend: https://6.docs.plone.org/backend/global-utils.html

read and verify: https://docs.plone.org/4/en/old-reference-manuals/plone_3_theming/buildingblocks/skin/templates/global-template-variables.html#global-template-variables

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 by reading the old global-template-variables reference and comparing it with the classic-ui documentation. Verify which global variables belong in classic-ui and which global utilities are covered by the backend global-utils page; done means the relevant globals are documented in the appropriate location.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.