Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix syntax of docker compose commands #914

Merged
merged 2 commits into from
Jan 5, 2023
Merged

Fix syntax of docker compose commands #914

merged 2 commits into from
Jan 5, 2023

Conversation

kmanwar89
Copy link
Contributor

Related Issue:

New Behavior

Update commands in readme file to align with current docker compose syntax.

Contrast to Current Behavior

If a user were to copy/paste the existing compose file in the README file, the docker-compose commands would fail. This syntax was changed in Compose v2 (source: https://docs.docker.com/compose/reference/)

Discussion: Benefits and Drawbacks

This PR is a simple fix to adjust syntax, that's all. No drawbacks, no compatibility to consider.

Changes to the Wiki

This PR is to update the README.md itself.

Proposed Release Note Entry

Updated compose syntax in README.md to current syntax

Double Check

  • I have read the comments and followed the PR template.
  • I have explained my PR according to the information in the comments.
  • My PR targets the develop branch.

tobiasge and others added 2 commits December 15, 2022 15:36
Docker compose's syntax changed as of Compose v2 (source: https://docs.docker.com/compose/reference/).  Replaced references of "docker-compose" with "docker compose" to align with this change.
@tobiasge tobiasge merged commit 015e131 into netbox-community:develop Jan 5, 2023
@kmanwar89 kmanwar89 deleted the patch-1 branch January 5, 2023 14:13
@tobiasge tobiasge mentioned this pull request Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants