Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Cookieplone entry in the Conceptual guide #1759

Open
stevepiercy opened this issue Nov 6, 2024 · 2 comments
Open

Create a Cookieplone entry in the Conceptual guide #1759

stevepiercy opened this issue Nov 6, 2024 · 2 comments

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Nov 6, 2024

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?
@Piyush-t24
Copy link

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
Copy link
Contributor Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: New
Development

No branches or pull requests

3 participants