Updates for the deployment instructions #11
Conversation
This file contains hidden or 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
yujiyokoo
reviewed
Jul 9, 2024
README.md
Outdated
| `git clone git@github.com:cipherstash/cipherstash-proxy-playground.git` | ||
| `cd cipherstash-proxy-playground` | ||
|
|
||
| This repository include a pre-configured config file located at `config/cipherstash/cipherstash-proxy.toml` which defines the configuration for the CipherStash Proxy. The definition for the various Docker containers that are used in the playground can be found in `docker-compose.yml` |
yujiyokoo
reviewed
Jul 9, 2024
README.md
Outdated
| Clone the repository into a new directory on your local machine. | ||
|
|
||
| `git clone git@github.com:cipherstash/cipherstash-proxy-playground.git` | ||
| `cd cipherstash-proxy-playground` |
There was a problem hiding this comment.
I reckon these should be lines inside triple back-ticks (```) so it looks like
command 1
command 2
rather than
command 1 command 2
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.
Adding in some pre-req &more specific getting started steps (clone the repo, get to the right directory). This PR doesn't fix all of the missing parts & specifically doesn't include what to look for when docker compose up is finished.