docs: Wording changes and proper syntax highlighting #188
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
lihebi
reviewed
Dec 31, 2022
k8s/helm-chart/README.md
Outdated
|
|
||
| To access prisma: | ||
|
|
||
| ```bash | ||
| kubectl port-forward prisma-deployment-5c9ccfc6b8-962vq 5555:5555 -n codepod-alpha |
There was a problem hiding this comment.
You forgot to remove this indentation.
Also, I deliberately used the indentation instead of ``` for small code blocks like these helm ones, because:
- indentation is easier and cleaner to read in plain text then
``` ```bashdoes not give it syntax highlighting anyway
There was a problem hiding this comment.
Both work. You could remove this indentation or change the small & unhighlighted commands back to indentation.
There was a problem hiding this comment.
Sorry for the inconvenience!
Eventually I opted to the first option which is to remove the indentation.
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.
Here are the detailed changes I've made