diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index 3b2d41e08c6..dd6ee9e217c 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -81,7 +81,30 @@ Always give the reader some idea of what to expect in the reference. Avoid blind When possible, use the exact title of the page or section you are linking to as the link text. **Example** -* Refer to the [Documentation style guide](documentation-style-guide.md) for information about word usage and capitalization guidelines. +Refer to the [Documentation style guide](documentation-style-guide.md) for information about word usage and capitalization guidelines. + +### Command line examples + +* Do not assume everyone is using Linux. Make sure instructions include enough information for Windows and Mac users to successfully complete procedures. + +* Do not add `$` before commands. Make it easy for users to copy and paste commands. + + * **Wrong:** `$ sudo yum install grafana` + * **Right:** `sudo yum install grafana` + +* Include `sudo` before commands that require `sudo` to work. + +For terminal examples and Grafana configuration, use a `bash` code block: +```bash +sudo yum install grafana +``` +For HTTP request/response, use an `http` code block: +```http +GET /api/dashboards/id/1/permissions HTTP/1.1 +Accept: application/json +Content-Type: application/json +Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk +``` ### Word usage