plone / plone/container-backend
Move README content into Plone 6 docs, leaving only version information
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 18
- Forks
- 18
- Avg merge
- 1h 32m
- Merged PRs (30d)
- 2
Description
READMEs should have only minimal information and not duplicate that which is already published in Plone 6 docs. This README currently has some non-duplicated information that should be moved into the docs, and replaced with a link to the docs.
See https://github.com/plone/plone-backend/pull/67#issuecomment-1280893500 for discussion, and suggested changes in https://github.com/plone/plone-backend/pull/67/files.
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
Start with the repository README and review the discussion and suggested changes in pull request #67. Identify the non-duplicated content, find its destination in the Plone 6 documentation, and replace the README material with a link while retaining only version information. Done means the relevant content is available in the docs and the README no longer duplicates it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100