Update README-docker-compose.md #10705
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace references to `docker-compose` command with `docker compose`. Make all bash commands copyable.
felliott
reviewed
Aug 15, 2024
README-docker-compose.md
Outdated
| - `$ docker-compose up --force-recreate --no-deps preprints` | ||
|
|
||
| ```bash | ||
| docker compose up --force-recreate --no-deps preprints` |
There was a problem hiding this comment.
Oops, just saw this trailing backtick.
|
Related to JIRA ticket https://openscience.atlassian.net/browse/ENG-6092. Merging this will close that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
docker-composehas been deprecated and is now built into the base Docker binary asdocker compose. Our README did not yet reflect this. Additionally, the README had a mixture of places where commands were easily copyable from the document and some where they were not., which adds overhead to the process of following the instructions and is just visually confusing.Changes
Replace references to
docker-composecommand withdocker compose.Move all directly-runnable bash code into a dedicated code block marked with ```bash and ensure proper formatting (e.g. remove preceding
$characters)QA Notes
Please make verification statements inspired by your code and what your code touches.
What are the areas of risk?
Any concerns/considerations/questions that development raised?
Documentation
Side Effects
Ticket