chore: replace excerpt with description property (#1505)

grafana · Feb 8, 2024 · 34349f9 · 34349f9
1 parent 8203633
commit 34349f9
Show file tree

Hide file tree

Showing 2,130 changed files with 2,130 additions and 2,130 deletions.
diff --git a/docs/sources/next/examples/api-crud-operations.md b/docs/sources/next/examples/api-crud-operations.md
@@ -1,6 +1,6 @@
 ---
 title: 'API CRUD Operations'
-excerpt: 'This example covers the usage of k6 to test a REST API CRUD operations.'
+description: 'This example covers the usage of k6 to test a REST API CRUD operations.'
 weight: 10
 ---
 

diff --git a/docs/sources/next/examples/bundling-and-transpilation.md b/docs/sources/next/examples/bundling-and-transpilation.md
@@ -1,7 +1,7 @@
 ---
 title: 'Bundling and transpilation'
 redirect: 'https://github.com/k6io/k6-es6/'
-excerpt: |
+description: |
   Reference project demonstrating how to use webpack and babel to bundle
   node modules or transpile code to ES5.1+ for usage in k6 tests.
 weight: 18

diff --git a/docs/sources/next/examples/cookies-example.md b/docs/sources/next/examples/cookies-example.md
@@ -1,6 +1,6 @@
 ---
 title: 'Cookies Example'
-excerpt: 'Scripting examples on how you can interact with cookies during your load test if required.'
+description: 'Scripting examples on how you can interact with cookies during your load test if required.'
 weight: 08
 ---
 

diff --git a/docs/sources/next/examples/correlation-and-dynamic-data.md b/docs/sources/next/examples/correlation-and-dynamic-data.md
@@ -1,7 +1,7 @@
 ---
 title: 'Correlation and Dynamic Data'
 slug: '/correlation-and-dynamic-data'
-excerpt: |
+description: |
   Scripting examples on how to correlate dynamic data in your test script. Correlation is
   often required when using the Chrome Extension or HAR converter to generate your test script.
   This is due to the fact that those tools will capture session IDs, CSRF tokens, VIEWSTATE,

diff --git a/docs/sources/next/examples/crawl-webpage.md b/docs/sources/next/examples/crawl-webpage.md
@@ -1,7 +1,7 @@
 ---
 title: 'Crawl a web page'
 redirect: 'https://stackoverflow.com/questions/60927653/downloading-whole-websites-with-k6/'
-excerpt: |
+description: |
   Stack overflow answer demonstrating how to crawl a web page
 weight: 17
 ---

diff --git a/docs/sources/next/examples/data-generation.md b/docs/sources/next/examples/data-generation.md
@@ -1,7 +1,7 @@
 ---
 title: 'Generating realistic data'
 redirect: 'https://github.com/k6io/example-data-generation/'
-excerpt: |
+description: |
   Reference project demonstrating how to generate data with realistic traits at runtime using faker.js
 weight: 16
 ---

diff --git a/docs/sources/next/examples/data-parameterization.md b/docs/sources/next/examples/data-parameterization.md
@@ -1,6 +1,6 @@
 ---
 title: 'Data Parameterization'
-excerpt: |
+description: |
   Scripting examples on how to parameterize data in a test script. Parameterization is typically
   necessary when Virtual Users(VUs) will make a POST, PUT, or PATCH request in a test.
 

diff --git a/docs/sources/next/examples/data-uploads.md b/docs/sources/next/examples/data-uploads.md
@@ -1,6 +1,6 @@
 ---
 title: 'Data Uploads'
-excerpt: 'Scripting examples on how to execute a load test that will upload a file to the System Under Test (SUT).'
+description: 'Scripting examples on how to execute a load test that will upload a file to the System Under Test (SUT).'
 weight: 09
 ---
 

diff --git a/docs/sources/next/examples/distribute-workloads.md b/docs/sources/next/examples/distribute-workloads.md
@@ -1,6 +1,6 @@
 ---
 title: Distribute workloads across VUs
-excerpt: How to configure different amounts of traffic for different VU behaviors
+description: How to configure different amounts of traffic for different VU behaviors
 slug: /distribute-workloads
 weight: 24
 ---

diff --git a/docs/sources/next/examples/functional-testing.md b/docs/sources/next/examples/functional-testing.md
@@ -1,6 +1,6 @@
 ---
 title: 'Functional testing'
-excerpt: |
+description: |
   Use Chaijs library for functional and integration testing.
 weight: 19
 ---

diff --git a/docs/sources/next/examples/generating-uuids.md b/docs/sources/next/examples/generating-uuids.md
@@ -1,6 +1,6 @@
 ---
 title: 'Generating UUIDs'
-excerpt: 'Scripting example on how to generate UUIDs in your load test.'
+description: 'Scripting example on how to generate UUIDs in your load test.'
 weight: 11
 ---
 

diff --git a/docs/sources/next/examples/get-started-with-k6/_index.md b/docs/sources/next/examples/get-started-with-k6/_index.md
@@ -1,6 +1,6 @@
 ---
 title: 'Get started with k6'
-excerpt: A series of docs to learn how to use the major features of k6
+description: A series of docs to learn how to use the major features of k6
 weight: 01
 weight: -10
 ---

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
@@ -1,6 +1,6 @@
 ---
 title: Analyze results
-excerpt: Use k6 to write custom metrics and filter results.
+description: Use k6 to write custom metrics and filter results.
 weight: 300
 ---
 

diff --git a/docs/sources/next/examples/get-started-with-k6/reuse-and-re-run-tests.md b/docs/sources/next/examples/get-started-with-k6/reuse-and-re-run-tests.md
@@ -1,6 +1,6 @@
 ---
 title: Reuse and re-run tests
-excerpt: Modularize your k6 test logic and workload configuration.
+description: Modularize your k6 test logic and workload configuration.
 weight: 400
 ---
 

diff --git a/docs/sources/next/examples/get-started-with-k6/test-for-functional-behavior.md b/docs/sources/next/examples/get-started-with-k6/test-for-functional-behavior.md
@@ -1,6 +1,6 @@
 ---
 title: Test for functional behavior
-excerpt: Use k6 to write requests and assert that they respond correctly
+description: Use k6 to write requests and assert that they respond correctly
 weight: 100
 ---
 

diff --git a/docs/sources/next/examples/get-started-with-k6/test-for-performance.md b/docs/sources/next/examples/get-started-with-k6/test-for-performance.md
@@ -1,6 +1,6 @@
 ---
 title: Test for performance
-excerpt: Write thresholds to evaluate performance criteria, then increase load to see how the system performs.
+description: Write thresholds to evaluate performance criteria, then increase load to see how the system performs.
 weight: 200
 ---
 

diff --git a/docs/sources/next/examples/get-timings-for-an-http-metric.md b/docs/sources/next/examples/get-timings-for-an-http-metric.md
@@ -1,6 +1,6 @@
 ---
 title: Get timings for an HTTP metric
-excerpt: How to calculate timings for an individual k6 metric
+description: How to calculate timings for an individual k6 metric
 weight: 23
 ---
 

diff --git a/docs/sources/next/examples/html-forms.md b/docs/sources/next/examples/html-forms.md
@@ -1,6 +1,6 @@
 ---
 title: 'HTML Forms'
-excerpt: 'Scripting example on how to handle HTML forms in a k6 test.'
+description: 'Scripting example on how to handle HTML forms in a k6 test.'
 weight: 07
 ---
 

diff --git a/docs/sources/next/examples/http-authentication.md b/docs/sources/next/examples/http-authentication.md
@@ -1,6 +1,6 @@
 ---
 title: 'HTTP Authentication'
-excerpt: 'Scripting examples on how to use different authentication or authorization methods in your load test.'
+description: 'Scripting examples on how to use different authentication or authorization methods in your load test.'
 weight: 02
 ---
 

diff --git a/docs/sources/next/examples/http2.md b/docs/sources/next/examples/http2.md
@@ -1,6 +1,6 @@
 ---
 title: 'HTTP2'
-excerpt: 'Information on how to load test HTTP/2.'
+description: 'Information on how to load test HTTP/2.'
 weight: 12
 ---
 

diff --git a/docs/sources/next/examples/instant-load-increase.md b/docs/sources/next/examples/instant-load-increase.md
@@ -1,6 +1,6 @@
 ---
 title: 'Instant load increase'
-excerpt: 'Scripting example on how to instantly increase the number of VUs or iterations and hold them for a period of time'
+description: 'Scripting example on how to instantly increase the number of VUs or iterations and hold them for a period of time'
 draft: 'false'
 weight: 22
 ---

diff --git a/docs/sources/next/examples/oauth-authentication.md b/docs/sources/next/examples/oauth-authentication.md
@@ -1,6 +1,6 @@
 ---
 title: 'OAuth Authentication'
-excerpt: 'Scripting examples on how to use OAuth authentication in your load test.'
+description: 'Scripting examples on how to use OAuth authentication in your load test.'
 weight: 03
 ---
 

diff --git a/docs/sources/next/examples/parse-html.md b/docs/sources/next/examples/parse-html.md
@@ -1,6 +1,6 @@
 ---
 title: 'Parse HTML'
-excerpt: 'Scripting examples parsing HTML content.'
+description: 'Scripting examples parsing HTML content.'
 weight: 06
 ---
 

diff --git a/docs/sources/next/examples/single-request.md b/docs/sources/next/examples/single-request.md
@@ -1,6 +1,6 @@
 ---
 title: 'Single request'
-excerpt: 'Example of one HTTP GET request'
+description: 'Example of one HTTP GET request'
 draft: 'false'
 weight: 01
 ---

diff --git a/docs/sources/next/examples/soap.md b/docs/sources/next/examples/soap.md
@@ -1,6 +1,6 @@
 ---
 title: 'SOAP'
-excerpt: 'Load Testing SOAP API.'
+description: 'Load Testing SOAP API.'
 weight: 14
 ---
 

diff --git a/docs/sources/next/examples/tls.md b/docs/sources/next/examples/tls.md
@@ -1,6 +1,6 @@
 ---
 title: 'Transport Layer Security (TLS)'
-excerpt: |
+description: |
   TLS is the mechanism through which encrypted connections can be established between clients and
   servers on the web and through which data can flow with integrity intact.
 weight: 15

diff --git a/docs/sources/next/examples/tracking-data-per.md b/docs/sources/next/examples/tracking-data-per.md
@@ -1,7 +1,7 @@
 ---
 title: 'Track transmitted data per URL'
 slug: '/track-transmitted-data-per-url'
-excerpt: 'This example shows how to track data sent and received for a individual URL.'
+description: 'This example shows how to track data sent and received for a individual URL.'
 weight: 20
 ---
 

diff --git a/docs/sources/next/examples/tutorials/_index.md b/docs/sources/next/examples/tutorials/_index.md
@@ -1,6 +1,6 @@
 ---
 title: 'Tutorials'
-excerpt: 'k6 Tutorials'
+description: 'k6 Tutorials'
 weight: 26
 ---
 

diff --git a/docs/sources/next/examples/url-query-parameters.md b/docs/sources/next/examples/url-query-parameters.md
@@ -1,6 +1,6 @@
 ---
 title: 'URLs with query parameters'
-excerpt: 'Scripting examples using URL and URLSearchParams modules.'
+description: 'Scripting examples using URL and URLSearchParams modules.'
 weight: 21
 ---
 

diff --git a/docs/sources/next/examples/websockets.md b/docs/sources/next/examples/websockets.md
@@ -1,6 +1,6 @@
 ---
 title: 'WebSockets'
-excerpt: |
+description: |
   Scripting example on how to use WebSocket API in k6.
 weight: 13
 ---

diff --git a/docs/sources/next/extensions/build-k6-binary-using-docker.md b/docs/sources/next/extensions/build-k6-binary-using-docker.md
@@ -1,6 +1,6 @@
 ---
 title: 'Build a k6 binary using Docker'
-excerpt: 'Guide to build a k6 binary with extensions using Docker.'
+description: 'Guide to build a k6 binary with extensions using Docker.'
 weight: 03
 ---
 

diff --git a/docs/sources/next/extensions/build-k6-binary-using-go.md b/docs/sources/next/extensions/build-k6-binary-using-go.md
@@ -1,6 +1,6 @@
 ---
 title: 'Build a k6 binary using Go'
-excerpt: 'Guide to build a k6 binary that includes one or many extensions using xk6.'
+description: 'Guide to build a k6 binary that includes one or many extensions using xk6.'
 weight: 02
 ---
 

diff --git a/docs/sources/next/extensions/create/_index.md b/docs/sources/next/extensions/create/_index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Create a k6 extension'
 menuTitle: 'Create an extension'
-excerpt: 'Creating k6 extensions does not have to be a daunting task, but there are some prerequisites to succeed.'
+description: 'Creating k6 extensions does not have to be a daunting task, but there are some prerequisites to succeed.'
 weight: 04
 ---
 

diff --git a/docs/sources/next/extensions/create/javascript-extensions.md b/docs/sources/next/extensions/create/javascript-extensions.md
@@ -1,6 +1,6 @@
 ---
 title: 'JavaScript Extensions'
-excerpt: 'Follow these steps to build a JS extension for k6.'
+description: 'Follow these steps to build a JS extension for k6.'
 weight: 01
 ---
 

diff --git a/docs/sources/next/extensions/create/output-extensions.md b/docs/sources/next/extensions/create/output-extensions.md
@@ -1,6 +1,6 @@
 ---
 title: 'Output Extensions'
-excerpt: 'Follow these steps to build an output extension for k6.'
+description: 'Follow these steps to build an output extension for k6.'
 weight: 02
 ---
 

diff --git a/docs/sources/next/extensions/explanations/extension-graduation.md b/docs/sources/next/extensions/explanations/extension-graduation.md
@@ -1,6 +1,6 @@
 ---
 title: Extension Graduation
-excerpt: Some extensions are created with the intent to become a part of core of k6.
+description: Some extensions are created with the intent to become a part of core of k6.
 weight: 03
 ---
 

diff --git a/docs/sources/next/extensions/explanations/extensions-registry.md b/docs/sources/next/extensions/explanations/extensions-registry.md
@@ -1,6 +1,6 @@
 ---
 title: About the Extensions Registry
-excerpt: Reasons for the registry and what is required to be included.
+description: Reasons for the registry and what is required to be included.
 weight: 01
 ---
 

diff --git a/docs/sources/next/extensions/explanations/go-js-bridge.md b/docs/sources/next/extensions/explanations/go-js-bridge.md
@@ -1,6 +1,6 @@
 ---
 title: About the Go-to-JS bridge
-excerpt: Technical details about how JavaScript works in the goja engine.
+description: Technical details about how JavaScript works in the goja engine.
 weight: 02
 ---
 

diff --git a/docs/sources/next/get-started/installation/_index.md b/docs/sources/next/get-started/installation/_index.md
@@ -1,6 +1,6 @@
 ---
 title: 'Installation'
-excerpt: 'k6 has packages for Linux, Mac, and Windows. As alternatives, you can also using a Docker container or a standalone binary.'
+description: 'k6 has packages for Linux, Mac, and Windows. As alternatives, you can also using a Docker container or a standalone binary.'
 weight: 02
 weight: 02
 ---

diff --git a/docs/sources/next/get-started/installation/troubleshooting.md b/docs/sources/next/get-started/installation/troubleshooting.md
@@ -1,6 +1,6 @@
 ---
 title: 'Troubleshooting'
-excerpt: 'Instructions to fix the most common installation issues.'
+description: 'Instructions to fix the most common installation issues.'
 weight: 01
 ---
 

diff --git a/docs/sources/next/get-started/resources.md b/docs/sources/next/get-started/resources.md
@@ -1,6 +1,6 @@
 ---
 title: k6 resources
-excerpt: 'An overview of the k6 resources beyond the k6 docs: videos, repositories, test servers, courses, and more'
+description: 'An overview of the k6 resources beyond the k6 docs: videos, repositories, test servers, courses, and more'
 weight: 05
 ---
 

diff --git a/docs/sources/next/get-started/results-output.md b/docs/sources/next/get-started/results-output.md
@@ -1,6 +1,6 @@
 ---
 title: 'Results output'
-excerpt: 'For basic tests, the top-level summary that k6 provides might be enough. For detailed analysis, you can stream all data your test outputs to an external source.'
+description: 'For basic tests, the top-level summary that k6 provides might be enough. For detailed analysis, you can stream all data your test outputs to an external source.'
 weight: 04
 ---
 

diff --git a/docs/sources/next/get-started/running-k6.md b/docs/sources/next/get-started/running-k6.md
@@ -1,6 +1,6 @@
 ---
 title: 'Running k6'
-excerpt: 'Follow along to learn how to run a test, add virtual users, increase the test duration, and ramp the number of requests up and down as the test runs.'
+description: 'Follow along to learn how to run a test, add virtual users, increase the test duration, and ramp the number of requests up and down as the test runs.'
 weight: 03
 ---
 

diff --git a/docs/sources/next/javascript-api/error-codes.md b/docs/sources/next/javascript-api/error-codes.md
@@ -1,6 +1,6 @@
 ---
 title: 'Error Codes'
-excerpt: 'Error codes are unique numbers that can be used to identify and handle different application and network errors more easily.'
+description: 'Error codes are unique numbers that can be used to identify and handle different application and network errors more easily.'
 weight: 13
 ---
 

diff --git a/docs/sources/next/javascript-api/init-context/_index.md b/docs/sources/next/javascript-api/init-context/_index.md
@@ -1,6 +1,6 @@
 ---
 title: 'Init context'
-excerpt: 'The init context (aka "init code") is code in the global context that has access to a few functions not accessible during main script execution.'
+description: 'The init context (aka "init code") is code in the global context that has access to a few functions not accessible during main script execution.'
 weight: 01
 ---
 

diff --git a/docs/sources/next/javascript-api/init-context/open.md b/docs/sources/next/javascript-api/init-context/open.md
@@ -2,7 +2,7 @@
 head_title: 'JavaScript API: open'
 title: 'open( filePath, [mode] )'
 description: 'Opens a file and reads all the contents into memory.'
-excerpt: 'Opens a file and reads all the contents into memory.'
+description: 'Opens a file and reads all the contents into memory.'
 ---
 
 # open( filePath, [mode] )

diff --git a/docs/sources/next/javascript-api/jslib/_index.md b/docs/sources/next/javascript-api/jslib/_index.md
@@ -1,6 +1,6 @@
 ---
 title: 'jslib'
-excerpt: 'External JavaScript libraries for k6'
+description: 'External JavaScript libraries for k6'
 weight: 15
 ---
 

diff --git a/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/_index.md
@@ -2,7 +2,7 @@
 title: 'EventBridgeClient'
 head_title: 'EventBridgeClient'
 description: 'EventBridgeClient allows interacting with AWS EventBridge service'
-excerpt: 'EventBridgeClient class allows sending custom events to Amazon EventBridge so that they can be matched to rules.'
+description: 'EventBridgeClient class allows sending custom events to Amazon EventBridge so that they can be matched to rules.'
 weight: 00
 ---