Skip to content

Comments

Revise Containers section and split image docs (Fixes #1761)#2058

Open
Manik-Khajuria-5 wants to merge 1 commit intoplone:6.0from
Manik-Khajuria-5:Revise-Container-Section
Open

Revise Containers section and split image docs (Fixes #1761)#2058
Manik-Khajuria-5 wants to merge 1 commit intoplone:6.0from
Manik-Khajuria-5:Revise-Container-Section

Conversation

@Manik-Khajuria-5
Copy link
Contributor

@Manik-Khajuria-5 Manik-Khajuria-5 commented Feb 14, 2026

Issue number

Description

This PR reorganizes the Containers and Official Images documentation to improve clarity, navigation, and alignment with Plone documentation guidelines.

screenshot-2026-02-14_18-17-05
screenshot-2026-02-14_18-17-27

📚 Documentation preview 📚: https://plone6--2058.org.readthedocs.build/

…ce guides

Fixes plone#1761

- Split containers/index.md into conceptual introduction and separate
  getting-started.md how-to guide
- Split each official image page (backend, frontend, zeo) into:
  - How-to guide (usage examples, extending, advanced usage)
  - Reference guide (environment variables tables)
- Add orchestration section to examples/index.md covering:
  - Docker Compose (primary tool for examples)
  - Docker Swarm (production deployments)
  - Other orchestration tools (Kubernetes, Podman Compose, Nomad)
- Update images/index.md to include all new reference files in toctree
- Add cross-references between how-to and reference documents

This reorganization separates:
- Conceptual guides (introduction and concepts)
- How-to guides (step-by-step instructions)
- Reference guides (environment variables and configuration options)
@Manik-Khajuria-5 Manik-Khajuria-5 changed the title z Revise Containers section and split image docs (Fixes #1761) Feb 14, 2026
@Manik-Khajuria-5 Manik-Khajuria-5 marked this pull request as ready for review February 14, 2026 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

Revise Containers section

1 participant