chore: fix prettier config and run prettier on all files (#1460)

* chore: update prettier parser to markdown * chore: run prettier on next folder * chore: run prettier on v0.48.x folder * chore: run prettier on v0.47.x folder * chore: fix indentation * chore: fix indentation * chore: apply patch to previous versions * chore: apply patch to v0.47 * chore: fix broken canonical links * chore: add S3MultipartUpload page * chore: fix indentation on running-k6
grafana · Jan 4, 2024 · 65b92a9 · 65b92a9
1 parent fb34756
commit 65b92a9
Show file tree

Hide file tree

Showing 891 changed files with 6,007 additions and 5,672 deletions.
diff --git a/docs/sources/.prettierrc b/docs/sources/.prettierrc
@@ -7,7 +7,7 @@
     {
       "files": ["**/*.md"],
       "options": {
-        "parser": "babel"
+        "parser": "markdown"
       }
     }
   ]

diff --git a/docs/sources/next/examples/api-crud-operations.md b/docs/sources/next/examples/api-crud-operations.md
@@ -154,7 +154,11 @@ export default (authToken) => {
 ```javascript
 import { describe, expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.3/index.js';
 import { Httpx } from 'https://jslib.k6.io/httpx/0.1.0/index.js';
-import { randomIntBetween, randomItem, randomString } from 'https://jslib.k6.io/k6-utils/1.2.0/index.js';
+import {
+  randomIntBetween,
+  randomItem,
+  randomString,
+} from 'https://jslib.k6.io/k6-utils/1.2.0/index.js';
 
 export const options = {
   // for the example, let's run only 1 VU with 1 iteration

diff --git a/docs/sources/next/examples/correlation-and-dynamic-data.md b/docs/sources/next/examples/correlation-and-dynamic-data.md
@@ -110,7 +110,7 @@ export default function () {
 **Relevant k6 APIs**:
 
 - [Selection.find(selector)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-html/selection/selection-find) (the [jQuery Selector API](http://api.jquery.com/category/selectors/)
-docs are also a good resource on what possible selector queries can be made)
+  docs are also a good resource on what possible selector queries can be made)
 - [Selection.attr(name)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-html/selection/selection-attr)
 
 ### Generic extraction of values/tokens

diff --git a/docs/sources/next/examples/data-uploads.md b/docs/sources/next/examples/data-uploads.md
@@ -118,7 +118,11 @@ const txt = open('/path/to/text.txt');
 export default function () {
   const fd = new FormData();
   fd.append('someTextField', 'someValue');
-  fd.append('aBinaryFile', { data: new Uint8Array(img1).buffer, filename: 'logo.png', content_type: 'image/png' });
+  fd.append('aBinaryFile', {
+    data: new Uint8Array(img1).buffer,
+    filename: 'logo.png',
+    content_type: 'image/png',
+  });
   fd.append('anotherTextField', 'anotherValue');
   fd.append('images', http.file(img1, 'image1.png', 'image/png'));
   fd.append('images', http.file(img2, 'image2.jpg', 'image/jpeg'));

diff --git a/docs/sources/next/examples/distribute-workloads.md b/docs/sources/next/examples/distribute-workloads.md
@@ -19,15 +19,15 @@ To inspect the results for a certain behavior, you can [create a custom metric](
 These techniques can create very complex configurations.
 However, more complexity creates more ambiguity in result interpretation
 
- {{% /admonition %}}
+{{% /admonition %}}
 
 ## Split logic across scenarios
 
 {{% admonition type="note" %}}
 
 In this context, _workload_ refers to the traffic pattern simulated by a scenario.
 
- {{% /admonition %}}
+{{% /admonition %}}
 
 One way to distribute traffic is to use scenarios to schedule different workloads for different functions.
 

diff --git a/docs/sources/next/examples/get-started-with-k6/_index.md b/docs/sources/next/examples/get-started-with-k6/_index.md
@@ -38,8 +38,8 @@ The tutorial requires the following:
 
 ## Tutorials
 
-| In this tutorial                                                                                                              | Learn how to                                                       |
-| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| In this tutorial                                                                                                                   | Learn how to                                                       |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
 | [Test for functional behavior](https://grafana.com/docs/k6/<K6_VERSION>/examples/get-started-with-k6/test-for-functional-behavior) | Use k6 to script requests and evaluate that performance is correct |
 | [Test for performance](https://grafana.com/docs/k6/<K6_VERSION>/examples/get-started-with-k6/test-for-performance)                 | Use k6 to increase load and find faults                            |
 | [Analyze results](https://grafana.com/docs/k6/<K6_VERSION>/examples/get-started-with-k6/analyze-results)                           | Filter results and make custom metrics                             |

diff --git a/docs/sources/next/examples/get-started-with-k6/analyze-results.md b/docs/sources/next/examples/get-started-with-k6/analyze-results.md
@@ -75,6 +75,7 @@ jq '. | select(.type == "Point" and .data.tags.status == "200")' results.json
 Or calculate the aggregated value of any metric with any particular tags.
 
 {{< code >}}
+
 ```average
 jq '. | select(.type == "Point" and .metric == "http_req_duration") | .data.value' results.json | jq -s 'add/length'
 ```
@@ -86,6 +87,7 @@ jq '. | select(.type == "Point" and .metric == "http_req_duration") | .data.valu
 ```max
 jq '. | select(.type == "Point" and .metric == "http_req_duration") | .data.value' results.json | jq -s max
 ```
+
 {{< /code >}}
 
 ## Apply custom tags
@@ -132,7 +134,7 @@ export default function () {
 }
 ```
 
-   {{< /code >}}
+{{< /code >}}
 
 Run the test:
 
@@ -193,8 +195,8 @@ export default function () {
   sleep(1);
 }
 ```
-{{< /code >}}
 
+{{< /code >}}
 
 ### Add Group functions
 
@@ -212,22 +214,22 @@ import { group, sleep } from 'k6';
 const baseUrl = 'https://test.k6.io';
 
 export default function () {
-// visit some endpoints in one group
-group('Contacts flow', function () {
-  http.get(`${baseUrl}/contacts.php`);
-  sleep(1);
-  // return to the home page
-  http.get(`${baseUrl}/`);
-  sleep(1);
-});
+  // visit some endpoints in one group
+  group('Contacts flow', function () {
+    http.get(`${baseUrl}/contacts.php`);
+    sleep(1);
+    // return to the home page
+    http.get(`${baseUrl}/`);
+    sleep(1);
+  });
 
-// Coinflip players in another group
-group('Coinflip game', function () {
-  http.get(`${baseUrl}/flip_coin.php?bet=heads`);
-  sleep(1);
-  http.get(`${baseUrl}/flip_coin.php?bet=tails`);
-  sleep(1);
-});
+  // Coinflip players in another group
+  group('Coinflip game', function () {
+    http.get(`${baseUrl}/flip_coin.php?bet=heads`);
+    sleep(1);
+    http.get(`${baseUrl}/flip_coin.php?bet=tails`);
+    sleep(1);
+  });
 }
 ```
 
@@ -279,35 +281,35 @@ const contactsLatency = new Trend('contacts_duration');
 const coinflipLatency = new Trend('coinflip_duration');
 
 export default function () {
-// Put visits to contact page in one group
-let res;
-group('Contacts flow', function () {
-  // save response as variable
-  res = http.get(`${baseUrl}/contacts.php`);
-  // add duration property to metric
-  contactsLatency.add(res.timings.duration);
-  sleep(1);
-
-  res = http.get(`${baseUrl}/`);
-  // add duration property to metric
-  contactsLatency.add(res.timings.duration);
-  sleep(1);
-});
+  // Put visits to contact page in one group
+  let res;
+  group('Contacts flow', function () {
+    // save response as variable
+    res = http.get(`${baseUrl}/contacts.php`);
+    // add duration property to metric
+    contactsLatency.add(res.timings.duration);
+    sleep(1);
+
+    res = http.get(`${baseUrl}/`);
+    // add duration property to metric
+    contactsLatency.add(res.timings.duration);
+    sleep(1);
+  });
 
-// Coinflip players in another group
+  // Coinflip players in another group
 
-group('Coinflip game', function () {
-  // save response as variable
-  let res = http.get(`${baseUrl}/flip_coin.php?bet=heads`);
-  // add duration property to metric
-  coinflipLatency.add(res.timings.duration);
-  sleep(1);
+  group('Coinflip game', function () {
+    // save response as variable
+    let res = http.get(`${baseUrl}/flip_coin.php?bet=heads`);
+    // add duration property to metric
+    coinflipLatency.add(res.timings.duration);
+    sleep(1);
 
-  res = http.get(`${baseUrl}/flip_coin.php?bet=tails`);
-  // add duration property to metric
-  coinflipLatency.add(res.timings.duration);
-  sleep(1);
-});
+    res = http.get(`${baseUrl}/flip_coin.php?bet=tails`);
+    // add duration property to metric
+    coinflipLatency.add(res.timings.duration);
+    sleep(1);
+  });
 }
 ```
 
@@ -329,6 +331,7 @@ contacts_duration..............: avg=125.76985 min=116.973  med=120.6735 max=200
 You can also query custom metric results from the JSON results. For example, to get the aggregated results as.
 
 {{< code >}}
+
 ```avg
 jq '. | select(.type == "Point" and .metric == "coinflip_duration") | .data.value' results.json | jq -s 'add/length'
 ```
@@ -340,6 +343,7 @@ jq '. | select(.type == "Point" and .metric == "coinflip_duration") | .data.valu
 ```max
 jq '. | select(.type == "Point" and .metric == "coinflip_duration") | .data.value' results.json | jq -s max
 ```
+
 {{< /code >}}
 
 ## Next steps