plone / plone/documentation

Add a how-to for creating a monorepo addon

Open
#2,059 2 comments 0 reactions 0 assignees View on GitHub

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.

No response

Description

Cookieplone-templates has a new template for creating a monorepo add-on with backend and frontend. (https://github.com/plone/cookieplone-templates/issues/338). It needs to be documented.

Compared to the existing monorepo project template, it is set up better for testing against multiple versions of Python and Plone. @ericof are there other significant features that make it better for an add-on?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading cookieplone-templates issue 338 and the existing monorepo project template documentation. Compare the add-on template's backend, frontend, and multi-version Python and Plone testing setup, then document how to create and test a monorepo add-on, including any confirmed differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.