Repository navigation
Improve Docker README for first-time contributors #3954
Description
While setting up SW360 locally using the Docker setup, I noticed a few areas in the Docker README that might be confusing for first-time contributors.
Examples:
- The sentence "Install a recent version of Docker build buildx support" appears to contain a typo.
- A quick start section explaining how to build and run the Docker setup could help new users.
- Adding a small troubleshooting section (for example CouchDB secrets configuration or disk space issues) might improve the setup experience.
I would be happy to contribute a small documentation improvement PR if this sounds useful.
Activity
ayushk687 commentedon Mar 20, 2026
@ranajiya PLEASE ASSIGN TO ME
ranajiya commentedon Mar 21, 2026
Hi @ayushk687, thanks for your interest.
Since I opened this issue and already identified the documentation improvements, I’m planning to prepare a small PR to update the Docker README.
Happy to collaborate if you have additional suggestions.
srivastavauddeshya98-lang commentedon Mar 23, 2026
Greetings @ranajiya , I am a new contributor preparing for GSoC 2026.
I would like to work on this issue.
Could you please guide me if there are any specific expectations for improving the Docker README?
srivastavauddeshya98-lang commentedon Mar 23, 2026
Hi, I have created a PR for this issue.
PR link:
#3975
Please let me know if any changes are needed.
GMishx commentedon Mar 23, 2026
Tools like SW360 are more of specialist. If you are playing with SW360, on a container, I would expect you to already know what Docker is. It is not the job of SW360 community to teach the users about Docker first.
Changes and fixes about typo are welcome. But other things like environment variables, secrets, etc are already documented well enough for anyone with basic docker experience https://github.com/eclipse-sw360/sw360/blob/main/README_DOCKER.md#configuration
srivastavauddeshya98-lang commentedon Mar 23, 2026
Thank you for the clarification. I understand that SW360 documentation assumes prior Docker knowledge. I will limit my future contributions to typo fixes, clarity improvements, or issues aligned with the project guidelines.