Add some basic top level documentation #46
Merged
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
nick-jones
approved these changes
May 23, 2022
Contributor
nick-jones
left a comment
nick-jones
left a comment
There was a problem hiding this comment.
LGTM, just one minor issue
README.md
Outdated
Comment on lines
15
to
16
| - The base relies on this [container](https://github.com/utilitywarehouse/docker-cockroach-cfssl-certs) it is used | ||
| as an init container to sign certificates on startup. |
Contributor
There was a problem hiding this comment.
Minor point, but the wording seems slighty off here. Maybe something like this instead?
- The base relies on [docker-cockroach-cfssl-certs](https://github.com/utilitywarehouse/docker-cockroach-cfssl-certs). It is executed via an init container, acquiring certificates on pod start.
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.
Same documentation as previous PR but not built on top of any other work.
Documentation