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

doc: Cleanup formatting #3017

Merged
merged 3 commits into from
Dec 2, 2020
Merged

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Dec 2, 2020

Signed-off-by: Jack Baldry jack.baldry@grafana.com

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Copy link
Member Author

jdbaldry commented Dec 2, 2020

I haven't made the change but generally I believe that using console syntax highlighting is better than bash for commands that are to be entered by a user, especially if some command output is included in the code block or a root command is to be run. Of course this is super minor and probably personal preference.

$ /run/this
and get this output
# /run/this/as/root
$ # this is a pseudo comment.
$ /run/this
and get this output
# /run/this/as/root
$ # this is a pseudo comment.

I'm not sure what the `..` means exactly.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@owen-d
Copy link
Member

owen-d commented Dec 2, 2020

Thanks.

re: highlighting - sounds good to me.

@owen-d owen-d merged commit 794c324 into master Dec 2, 2020
@owen-d owen-d deleted the jdb/cleanup-troubleshooting-formatting branch December 2, 2020 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants