Backend instructions should explain how to add add-ons
Open
Nobody has claimed this yet.
42 lvl: moderate
99 tag: backend
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Plone Documentation versions affected
- 5.x
- 6.x
Description
The plone-backend container documentation does not explain how to add add-ons except through ADDONS variable, which is explicitly said not to be for production.
Perhaps we should explain this in the docs too. Here is how I do it:
COPY dist/ dist/
RUN echo Installing dist/*.tar.gz >&2 && \
./bin/pip -q install dist/*.tar.gz && \
./bin/pip check && \
echo ===Packages installed in the container image=== >&2 && \
./bin/pip freeze && \
echo =/=Packages installed in the container image=/= >&2
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.
Research direction
Update docs/install/containers/images/backend.md, focusing on the existing explanation of the ADDONS variable. Document the provided Dockerfile approach for copying distribution archives and installing them with pip, including the checks shown; done means production add-on installation is explained alongside the ADDONS limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100