Fix markdown tables on the website, make example commands consistent. #159
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
joerg84
approved these changes
Mar 27, 2019
| @@ -36,15 +36,15 @@ zk-deploy-392770000 11s | |||
| The statefulset defined in the `FrameworkVersion` comes up with 3 pods: | |||
|
|
|||
| ```bash | |||
| kubectl get statefulset zk-zk | |||
| $ kubectl get statefulset zk-zk | |||
There was a problem hiding this comment.
I am always torn whether to add that to commands in documentation or not as it makes copying them more annoying. As it is a single line here, I don't believe it matters too much...
There was a problem hiding this comment.
yeah I thought about this too and there are other places in the docs where we don't use $ when there are multiple commands you can copy. It just makes it hard to distinguish command from output when both are in the same block.
| |---|---| | ||
| | `kubectl kudo install <name> [flags]` | Installs a Framework from the official [KUDO repo](https://github.com/kudobuilder/frameworks). | | ||
| | `kubectl kudo list instances [flags]` | Show all available instances. | | ||
| | `kubectl kudo list instances [flags]` | Show all available instances. | |
There was a problem hiding this comment.
Just as a note: We could make the verb consistent (Show all vs View all below)
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.
What type of PR is this?
/kind documentation