Create a Cookieplone entry in the Conceptual guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation, tooling
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.
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?
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
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.
More from plone/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
plone/documentation#2077 · 1 comment ·
-
99 tag: sprint
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
plone/documentation#1336 · 9 comments ·
-
31 needs: help 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest 99 tag: Plone 6.x dependencies
Difficulty 3/5 1-2 days Newbie friendliness 68/100
plone/documentation#2100 ·
-
plone/documentation#2076 · 1 assignee ·
-
33 needs: docs 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest
Difficulty 3/5 1-2 days Newbie friendliness 55/100
plone/documentation#2065 · 8 comments · 1 reaction ·
All issues in plone/documentation
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·