plone / plone/documentation

Adding backend Plone add-on in backend/requirements.txt is ignored in backend/.gitignore in Cookieplone project

Open
#1,938 7 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

Adding a Plone addon to the backend in backend/requirements.txt is not taken by git.

When you need to add an Plone addon to the backend and you follow the instructions on page /admin-guide/add-ons.html you would add the package to the file backend/requirements.txt, the change does not show up in git.

see: https://6.docs.plone.org/admin-guide/add-ons.html#install-an-add-on

Goal: Explain the right place to add the addons in the docs matching the Cookiecutter setup (or the other way round)
  • The docs should refer to the right place to add the addons and constraints in a Cookiecutter based setup!
  • or the Cookiecutter based setup needs to match the docs!
  • Optional: Add a reference to the related latest docs in the main README.md or backend/README.md
Solution?

I cannot suggest a PR because I am not aware of the latest changes and where the issue has to be fixed

backend/requirements.txt is covered in the backend/.gitignore rules

Version from the README.md:
Generated using Cookieplone (0.9.6) and cookieplone-templates (696f111) on 2025-04-10 15:15:45.110547.

In this setup in the backend/.gitignore contains:

...
# mxdev
...
/*-mxdev.txt
...
constraints*.txt
requirements*.txt
Other stuff

There is no setup.py anymore

Former behaviour

Generated using Cookieplone (0.8.3) and cookiecutter-plone (91f7d2b) on 2025-02-13 18:18:49.930741.

In this former version of the cookieplone-template the backend/.gitignore contained:

...
# mxdev
...
/*-mxdev.txt
...

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 comparing /admin-guide/add-ons.html with backend/requirements.txt and the backend/.gitignore rules described in the issue, then check the generated README.md and backend/README.md. Confirm whether the documentation or Cookieplone setup is authoritative, and consider the related README reference; done means the documented add-on location and generated setup agree.

Written by the indexing model from the issue text.

Assessment

Domain
backend, 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.