Skip to content

Create a Cookieplone entry in the Conceptual guide #1759

Open
@stevepiercy

Description

@stevepiercy

Links of affected pages in Plone Documentation, if any.

Conceptual guides

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, 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.
  • Other?

Activity

added this to the Plone 6.1 milestone on Nov 6, 2024
Piyush-t24

Piyush-t24 commented on Jan 29, 2025

@Piyush-t24

Hi Steve,

I’ve compiled a guide on how Cookieplone works, based on my research, and attached the PDF for your review. Could you please check if the information is helpful and let me know if any changes are needed?

Also, I’m interested in contributing to the codebase. Do you think this guide is a good starting point, or are there specific areas I should focus on?

Cookieplone guide.pdf

stevepiercy

stevepiercy commented on Jan 29, 2025

@stevepiercy
ContributorAuthor

@Piyush-t24 I think it's merely recycled material from Cookieplone's readme and not useful in this context. I updated the issue description to clarify a few things and set expectations.

I don't know the best place for you to start. I enjoy writing docs. I'd suggest starting wherever your interests may lay.

I recommend that you read and follow First-time contributors and Contributing to Plone as your entry points. I wrote them, so of course I'm biased.

pinned this issue on Feb 10, 2025
moved this from New to Todo in Plone Documentationon Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    • Status

      Todo

    Relationships

    None yet

    Development

    No branches or pull requests

      Participants

      @stevepiercy@Piyush-t24@KrishnaShuk

      Issue actions

        Create a Cookieplone entry in the Conceptual guide · Issue #1759 · plone/documentation