Revise Containers section
Open
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Here's a road map for reorganizing and revising the parts of the Containers section.
- Containers - Mix of Conceptual guide (introduction) and How-to (the rest of the page).
- Official Images - Each page is a mix of Reference (environment variables) and How-to, and should be split apart. I'd break each page into two.
- Examples of Plone 6 using containers - How-to. Add orchestration examples using Docker / docker-compose / Docker Swarm (and maybe other tools?).
Originally posted by @stevepiercy in https://github.com/plone/documentation/issues/1729#issuecomment-2460960816
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Containers, Official Images, and Examples pages linked in the issue, noting how conceptual, reference, and how-to content is currently organized. Done means the sections are reorganized as described, the Official Images pages separate reference from how-to material, and container orchestration examples are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, docker-compose
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100