Skip to content

Fix formatting of installation commands #9803

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

Conversation

Chris-Johnston
Copy link
Contributor

@Chris-Johnston Chris-Johnston commented Jul 7, 2019

Description:

This change fixes the formatting of the generic linux host installation commands so that they all begin with $. This ensures that they are rendered correctly in the documentation.

Previously, the commands under $ sudo -i all began with # (to indicate that the shell was running as root). While this is correct, the markdown formatting thinks that they are comments, so they are rendered in a light gray color. I think that it's better that they are shown as commands and not comments.

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created against current.
  • The documentation follows the standards.

This change fixes the formatting of the generic linux host
installation commands so that they all begin with `$`.
This ensures that they are rendered correctly in the documentation.

Previously, the commands under `$ sudo -i` all began with `#` (to
indicate that the shell was running as root). While this is correct,
the markdown formatting thinks that they are comments, so they
are rendered in a light gray color.
@klaasnicolaas klaasnicolaas added current This PR goes into the current branch enhancement ready-for-review This PR needs to be reviewed labels Jul 7, 2019
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Actually, none of the commands produce output, so all preceding has to be removed.

See Markdown style guides rule 14:

https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md014---dollar-signs-used-before-commands-without-showing-output

@frenck frenck added in-progress This PR/Issue is currently being worked on and removed ready-for-review This PR needs to be reviewed labels Jul 7, 2019
none of the commands produce any output, so all of the symbols
should be removed
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks for adjusting this so quickly @Chris-Johnston! 👍

@frenck frenck removed the in-progress This PR/Issue is currently being worked on label Jul 7, 2019
@frenck frenck merged commit b241c22 into home-assistant:current Jul 7, 2019
@Chris-Johnston Chris-Johnston deleted the docs/installation-commands-formatting branch July 7, 2019 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants