Create a Cookieplone entry in the Conceptual guide
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Links of affected pages in Plone Documentation, if any.
Description
Plone documentation uses "conceptual guide" as a synonym for "explanation", as defined in the Diátaxis framework.
Cookieplone is not well understood by the broader Plone developer community. A conceptual guide for Cookieplone could include:
- A diagram of the workflow, from running Cookieplone to generate a project, to project installation, to project development, documentation, project deployment and management, and beyond. Plone Documentation supports both Mermaid and Graphviz formats. Source code for generating a diagram must be included, and exported as SVG.
- Describe all the tools that come with a Cookieplone project, especially those in devops and documentation.
- Cull information from https://training.plone.org/plone-deployment/ as needed.
- Other?
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 existing Conceptual guides and the Cookieplone-related material in the linked Plone deployment training. Define the guide around the workflow from project generation through deployment and management, documenting the included development, DevOps, and documentation tools. Add source for the workflow diagram in a supported Mermaid or Graphviz format and export it as SVG; completion means the new guide is published in the Conceptual guides section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100