Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs code blocks chart/kubeapps/readme #1645

Merged
merged 2 commits into from
Apr 8, 2020

Conversation

tiffanyfay
Copy link
Contributor

@tiffanyfay tiffanyfay commented Apr 8, 2020

Description of the change

  • Removes $ from code commands because it makes copy-pasting easier. Otherwise you have to make sure you skip the $, or you get an error (at least on my mac with zsh).
  • Swaps console type to bash type for consistency and also because console is only really useful if you're showing commands to be run and the output to distinguish between them.

Benefits

See above

Possible drawbacks

Applicable issues

Additional information

@tiffanyfay
Copy link
Contributor Author

Should the two blocks in https://github.com/kubeapps/kubeapps/pull/1645/files#diff-fd1223ba99ae8afb3850192caf05b551L198 be bash also? I didn't put anything since they're errors.

Copy link
Contributor

@absoludity absoludity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks.

@absoludity
Copy link
Contributor

Should the two blocks in https://github.com/kubeapps/kubeapps/pull/1645/files#diff-fd1223ba99ae8afb3850192caf05b551L198 be bash also? I didn't put anything since they're errors.

The link doesn't drop me at a specific line, but I assume you mean the ones at:

https://github.com/kubeapps/kubeapps/blob/master/chart/kubeapps/README.md#troubleshooting

then I'm not sure it matters (trying it here in the editor with or without doesn't change the presentation, and not sure it matters semantically for the errors). I'll merge as is :)

@absoludity absoludity merged commit 3fefc31 into vmware-tanzu:master Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants