PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)

* Format md,mdx files with prettier on lint-staged * Manually run prettier on docs/sources
2021-08-06 07:52:36 -06:00
parent e9c032f10f
commit b78a67cec7
301 changed files with 3216 additions and 2980 deletions
@@ -21,30 +21,34 @@ There are two authentication methods to access the API:
 The task is to create a new organization and then add a Token that can be used by other users. In the examples below which use basic auth, the user is `admin` and the password is `admin`.

 1. [Create the org](http://docs.grafana.org/http_api/org/#create-organization). Here is an example using curl:
-    ```bash
-    curl -X POST -H "Content-Type: application/json" -d '{"name":"apiorg"}' http://admin:admin@localhost:3000/api/orgs
-    ```

-    This should return a response: `{"message":"Organization created","orgId":6}`. Use the orgId for the next steps.
+   ```bash
+   curl -X POST -H "Content-Type: application/json" -d '{"name":"apiorg"}' http://admin:admin@localhost:3000/api/orgs
+   ```
+
+   This should return a response: `{"message":"Organization created","orgId":6}`. Use the orgId for the next steps.

 1. Optional step. If the org was created previously and/or step 3 fails then first [add your Admin user to the org](http://docs.grafana.org/http_api/org/#add-user-in-organization):
-    ```bash
-    curl -X POST -H "Content-Type: application/json" -d '{"loginOrEmail":"admin", "role": "Admin"}' http://admin:admin@localhost:3000/api/orgs/<org id of new org>/users
-    ```
+
+   ```bash
+   curl -X POST -H "Content-Type: application/json" -d '{"loginOrEmail":"admin", "role": "Admin"}' http://admin:admin@localhost:3000/api/orgs/<org id of new org>/users
+   ```

 1. [Switch the org context for the Admin user to the new org](http://docs.grafana.org/http_api/user/#switch-user-context-for-signed-in-user):
-    ```bash
-    curl -X POST http://admin:admin@localhost:3000/api/user/using/<id of new org>
-    ```
+
+   ```bash
+   curl -X POST http://admin:admin@localhost:3000/api/user/using/<id of new org>
+   ```

 1. [Create the API token](http://docs.grafana.org/http_api/auth/#create-api-key):
-    ```bash
-    curl -X POST -H "Content-Type: application/json" -d '{"name":"apikeycurl", "role": "Admin"}' http://admin:admin@localhost:3000/api/auth/keys
-    ```

-    This should return a response: `{"name":"apikeycurl","key":"eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ=="}`.
+   ```bash
+   curl -X POST -H "Content-Type: application/json" -d '{"name":"apikeycurl", "role": "Admin"}' http://admin:admin@localhost:3000/api/auth/keys
+   ```

-    Save the key returned here in your password manager as it is not possible to fetch again it in the future.
+   This should return a response: `{"name":"apikeycurl","key":"eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ=="}`.
+
+   Save the key returned here in your password manager as it is not possible to fetch again it in the future.

 ## How to add a dashboard

@@ -52,22 +56,22 @@ Using the Token that was created in the previous step, you can create a dashboar

 1. [Add a dashboard](http://docs.grafana.org/http_api/dashboard/#create-update-dashboard) using the key (or bearer token as it is also called):

-  ```bash
-  curl -X POST --insecure -H "Authorization: Bearer eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ==" -H "Content-Type: application/json" -d '{
-    "dashboard": {
-      "id": null,
-      "title": "Production Overview",
-      "tags": [ "templated" ],
-      "timezone": "browser",
-      "rows": [
-        {
-        }
-      ],
-      "schemaVersion": 6,
-      "version": 0
-    },
-    "overwrite": false
-  }' http://localhost:3000/api/dashboards/db
-  ```
+```bash
+curl -X POST --insecure -H "Authorization: Bearer eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ==" -H "Content-Type: application/json" -d '{
+  "dashboard": {
+    "id": null,
+    "title": "Production Overview",
+    "tags": [ "templated" ],
+    "timezone": "browser",
+    "rows": [
+      {
+      }
+    ],
+    "schemaVersion": 6,
+    "version": 0
+  },
+  "overwrite": false
+}' http://localhost:3000/api/dashboards/db
+```

-  > **Note:** If you export a dashboard for sharing externally using the Share > Export menu in the Grafana UI, you cannot import that dashboard. Instead, click **View JSON** and save it to a file or fetch the JSON output through the API.
+> **Note:** If you export a dashboard for sharing externally using the Share > Export menu in the Grafana UI, you cannot import that dashboard. Instead, click **View JSON** and save it to a file or fetch the JSON output through the API.