NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Add minimal version of docker compose in prerequisites
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
None
Please provide a link or source to the relevant docs
https://github.com/NVIDIA/nv-ingest/blob/main/README.md
Describe the problems in the documentation
Error Additional property required is not allowed when running with old version of docker compose. It starts to be supported starting version 2.17.0
(Optional) Propose a correction or improvement
Add the minimal docker compose version to prerequisites. It should be at least 2.17.0 to be able to run without issues.
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
Open README.md and locate the prerequisites section. Confirm how Docker Compose is currently described, then state that version 2.17.0 or newer is required to avoid the reported error. The work is done when the minimum version is clearly included in the prerequisites.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100