docs: added bash and http syntax highlighting

2025-08-03 01:56:56 +08:00 · 2017-05-08 08:02:08 +02:00
parent e2f0b42d90
commit 823b40a360
2 changed files with 106 additions and 78 deletions
--- a/docs/sources/http_api/dashboard.md
+++ b/docs/sources/http_api/dashboard.md
@ -19,26 +19,28 @@ Creates a new dashboard or updates an existing dashboard.

 **Example Request for new dashboard**:

-    POST /api/dashboards/db HTTP/1.1
-    Accept: application/json
-    Content-Type: application/json
-    Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```http
+POST /api/dashboards/db HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

-    {
-      "dashboard": {
-        "id": null,
-        "title": "Production Overview",
-        "tags": [ "templated" ],
-        "timezone": "browser",
-        "rows": [
-          {
-          }
-        ],
-        "schemaVersion": 6,
-        "version": 0
-      },
-      "overwrite": false
-    }
+```
+
+JSON Body schema:
+
+- **dashboard** – The complete dashboard model, id = null to create a new dashboard
+- **overwrite** – Set to true if you want to overwrite existing dashboard with newer version or with same dashboard title.
+
+**Example Response**:
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json; charset=UTF-8
+Content-Length: 78
+
+```
+
 Status Codes:

 - **200** – Created
@ -47,15 +49,17 @@ JSON Body schema:
 - **412** – Precondition failed

 The **412** status code is used when a newer dashboard already exists (newer, its version is greater than the version that was sent). The
-    HTTP/1.1 200 OK
-    Content-Type: application/json; charset=UTF-8
-    Content-Length: 78
+same status code is also used if another dashboard exists with the same title. The response body will look like this:
+
+```http
+HTTP/1.1 412 Precondition Failed
 Content-Type: application/json; charset=UTF-8
-    {
-      "slug": "production-overview",
-      "status": "success",
-      "version": 1
-    }
+Content-Length: 97
+
+```
+
+In in case of title already exists the `status` property will be `name-exists`.
+
 ## Get dashboard

 `GET /api/dashboards/db/:slug`
@ -67,14 +71,16 @@ Status Codes:
 ```http
 GET /api/dashboards/db/production-overview HTTP/1.1
 Accept: application/json
-    HTTP/1.1 412 Precondition Failed
-    Content-Type: application/json; charset=UTF-8
-    Content-Length: 97
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
 **Example Response**:
-    {
-      "message": "The dashboard has been changed by someone else",
-      "status": "version-mismatch"
-    }
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+
 ```

 ## Delete dashboard
@ -86,34 +92,38 @@ Will return the dashboard given the dashboard slug. Slug is the url friendly ver
 **Example Request**:

 ```http
-    GET /api/dashboards/db/production-overview HTTP/1.1
-    Accept: application/json
-    Content-Type: application/json
-    Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+DELETE /api/dashboards/db/test HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
 **Example Response**:

 ```http
-    HTTP/1.1 200
-    Content-Type: application/json
+HTTP/1.1 200
+Content-Type: application/json
+
 ```
-    {
-      "meta": {
-        "isStarred": false,
-        "slug": "production-overview"
-      },
-      "dashboard": {
-        "id": null,
-        "title": "Production Overview",
-        "tags": [ "templated" ],
-        "timezone": "browser",
-        "rows": [
-          {
-          }
-        ],
-        "schemaVersion": 6,
-        "version": 0
+
+## Gets the home dashboard
+
+`GET /api/dashboards/home`
+
+Will return the home dashboard.
+
+**Example Request**:
+
+    GET /api/dashboards/home HTTP/1.1
+    Accept: application/json
+    Content-Type: application/json
    Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
-    }
+
+**Example Response**:
+
+    HTTP/1.1 200
+    Content-Type: application/json
+
    {
      "meta":	{
        "isHome":true,
@ -123,17 +133,21 @@ The above will delete the dashboard with the specified slug. The slug is the url
        "slug":"",
        "expires":"0001-01-01T00:00:00Z",
        "created":"0001-01-01T00:00:00Z"
-    DELETE /api/dashboards/db/test HTTP/1.1
-    Accept: application/json
-    Content-Type: application/json
-    Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+      },
+      "dashboard": {
+        "editable":false,
+        "hideControls":true,
+        "nav":[
+        {
          "enable":false,
        "type":"timepicker"
        }
-    HTTP/1.1 200
-    Content-Type: application/json
+        ],
+        "rows": [
+          {

-    {"title": "Test"}
+          }
+        ],
        "style":"dark",
        "tags":[],
        "templating":{
--- a/docs/sources/installation/debian.md
+++ b/docs/sources/installation/debian.md
@ -22,10 +22,10 @@ installation.

 ## Install Stable

-```
-$ wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.2.0_amd64.deb
-$ sudo apt-get install -y adduser libfontconfig
-$ sudo dpkg -i grafana_4.2.0_amd64.deb
+```bash
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.2.0_amd64.deb
+sudo apt-get install -y adduser libfontconfig
+sudo dpkg -i grafana_4.2.0_amd64.deb
 ```

 ## APT Repository
@ -43,18 +43,24 @@ candidates.
 Then add the [Package Cloud](https://packagecloud.io/grafana) key. This
 allows you to install signed packages.

-    $ curl https://packagecloud.io/gpg.key | sudo apt-key add -
+```bash
+curl https://packagecloud.io/gpg.key | sudo apt-key add -
+```

 Update your Apt repositories and install Grafana

-    $ sudo apt-get update
-    $ sudo apt-get install grafana
+```bash
+sudo apt-get update
+sudo apt-get install grafana
+```

 On some older versions of Ubuntu and Debian you may need to install the
 `apt-transport-https` package which is needed to fetch packages over
 HTTPS.

-    $ sudo apt-get install -y apt-transport-https
+```bash
+sudo apt-get install -y apt-transport-https
+```

 ## Package details

@ -70,7 +76,9 @@ HTTPS.

 Start Grafana by running:

-    $ sudo service grafana-server start
+```bash
+sudo service grafana-server start
+```

 This will start the `grafana-server` process as the `grafana` user,
 which was created during the package installation. The default HTTP port
@ -78,19 +86,25 @@ is `3000` and default user and group is `admin`.

 To configure the Grafana server to start at boot time:

-    $ sudo update-rc.d grafana-server defaults
+```bash
+sudo update-rc.d grafana-server defaults
+```

 ## Start the server (via systemd)

 To start the service using systemd:

-    $ systemctl daemon-reload
-    $ systemctl start grafana-server
-    $ systemctl status grafana-server
+```bash
+systemctl daemon-reload
+systemctl start grafana-server
+systemctl status grafana-server
+```

 Enable the systemd service so that Grafana starts at boot.

-    sudo systemctl enable grafana-server.service
+```bash
+sudo systemctl enable grafana-server.service
+```

 ## Environment file