Skip to content

docs(docker): remove reference to nonexistent database-compose.yml#339

Merged
MoralCode merged 1 commit into
chaoss:mainfrom
Suraj-H675:docs/fix-docker-compose-reference
May 26, 2026
Merged

docs(docker): remove reference to nonexistent database-compose.yml#339
MoralCode merged 1 commit into
chaoss:mainfrom
Suraj-H675:docs/fix-docker-compose-reference

Conversation

@Suraj-H675

Copy link
Copy Markdown

What problem does this solve?

Updates the docker-compose documentation to remove a reference to database-compose.yml, a file that no longer exists in the repository. The Docker Compose setup now includes all services (including database) directly in docker-compose.yml, so running docker compose up is sufficient. Closes #333.

What changed and why?

  • Removed -f database-compose.yml flag from the "with database container" example in docs/source/docker/docker-compose.rst
  • The file database-compose.yml has not existed for some time, making this reference misleading to contributors

How was this tested?

  • Verified docker-compose.yml exists and contains the database service definition
  • No database-compose.yml file exists in the repository

Checklist

  • Read CONTRIBUTING.md
  • Changes match project coding style
  • No test needed (documentation-only change)
  • CI tool verified: docs build command identified as make docs

This contribution was created with AI assistance, with human review and approval at each step.

The file database-compose.yml no longer exists in the repository. The Docker
Compose setup now includes the database service directly in docker-compose.yml.

Closes #333

Signed-off-by: Suraj <surajh6705@gmail.com>
@MoralCode

MoralCode commented May 26, 2026

Copy link
Copy Markdown
Contributor

Welcome to the project! Is there a reason this is marked as a draft?

@Suraj-H675

Copy link
Copy Markdown
Author

Thank you for the quick review! Removing the draft status now — all CI checks should run shortly.

@Suraj-H675 Suraj-H675 marked this pull request as ready for review May 26, 2026 18:39
@Suraj-H675 Suraj-H675 requested a review from MoralCode as a code owner May 26, 2026 18:39
@MoralCode

Copy link
Copy Markdown
Contributor

no problem! thanks for the PR

You should also join CHAOSS Slack in the #wg-collectoss-8knot channel to chat with other maintainers/contributors, get notified when we have meetings, etc.

@MoralCode

Copy link
Copy Markdown
Contributor

Docs build CI task completed. merging

@MoralCode MoralCode merged commit bee5a30 into chaoss:main May 26, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docker compose docs to remove reference to nonexistent compose file

2 participants