MariaDB / MariaDB/feedback-plugin-backend
MDBF-421: Create documentation in Readme.md how to start properly locally (from virtual env)
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Documentation is only using docker compose but is missing information about local deployment without containerization, using virtual environments.
Contributor guide
No contributing guide indexed for this repository
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
Open Readme.md and review the existing docker compose setup instructions alongside the repository's virtual-environment workflow. Document how to deploy locally without containers, including the setup and startup steps, and verify that the README clearly explains the resulting backend workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100