From ddfa6d9a28eb0c7d7a3a906360b60450032fa45e Mon Sep 17 00:00:00 2001 From: Pepe Cano <825430+ppcano@users.noreply.github.com> Date: Tue, 2 Mar 2021 10:45:22 +0100 Subject: [PATCH] Scenarios: add `required` superscript --- .../14 Scenarios/01 Executors/01 shared-iterations.md | 6 +++--- .../14 Scenarios/01 Executors/02 per-vu-iterations.md | 6 +++--- .../14 Scenarios/01 Executors/03 constant-vus.md | 4 ++-- .../14 Scenarios/01 Executors/04 ramping-vus.md | 6 +++--- .../01 Executors/05 constant-arrival-rate.md | 10 +++++----- .../01 Executors/06 ramping-arrival-rate.md | 10 +++++----- .../01 Executors/07 externally-controlled.md | 6 +++--- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/01 shared-iterations.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/01 shared-iterations.md index 23761dc851..bbae1f61d8 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/01 shared-iterations.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/01 shared-iterations.md @@ -16,9 +16,9 @@ also adds the following options: | Option | Type | Description | Default | | ------------- | ------- | ---------------------------------------------------------------------------------- | ------- | -| `vus` | integer | Number of VUs to run concurrently. | `1` | -| `iterations` | integer | Total number of script iterations to execute across all VUs. | `1` | -| `maxDuration` | string | Maximum scenario duration before it's forcibly stopped (excluding `gracefulStop`). | `"10m"` | +| vus | integer | Number of VUs to run concurrently. | `1` | +| iterations | integer | Total number of script iterations to execute across all VUs. | `1` | +| maxDuration | string | Maximum scenario duration before it's forcibly stopped (excluding `gracefulStop`). | `"10m"` | ### When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/02 per-vu-iterations.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/02 per-vu-iterations.md index 42c3b46ccf..bd97f37088 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/02 per-vu-iterations.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/02 per-vu-iterations.md @@ -15,9 +15,9 @@ also adds the following options: | Option | Type | Description | Default | | ------------- | ------- | ---------------------------------------------------------------------------------- | ------- | -| `vus` | integer | Number of VUs to run concurrently. | `1` | -| `iterations` | integer | Number of `exec` function iterations to be executed by each VU. | `1` | -| `maxDuration` | string | Maximum scenario duration before it's forcibly stopped (excluding `gracefulStop`). | `"10m"` | +| vus | integer | Number of VUs to run concurrently. | `1` | +| iterations | integer | Number of `exec` function iterations to be executed by each VU. | `1` | +| maxDuration | string | Maximum scenario duration before it's forcibly stopped (excluding `gracefulStop`). | `"10m"` | ## When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/03 constant-vus.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/03 constant-vus.md index f527122dee..525726fc32 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/03 constant-vus.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/03 constant-vus.md @@ -15,8 +15,8 @@ also adds the following options: | Option | Type | Description | Default | | ----------- | ------- | --------------------------------------------------- | ------- | -| `duration*` | string | Total scenario duration (excluding `gracefulStop`). | - | -| `vus` | integer | Number of VUs to run concurrently. | `1` | +| duration(required) | string | Total scenario duration (excluding `gracefulStop`). | - | +| vus | integer | Number of VUs to run concurrently. | `1` | ## When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/04 ramping-vus.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/04 ramping-vus.md index 6947495e27..a946ff3e80 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/04 ramping-vus.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/04 ramping-vus.md @@ -15,9 +15,9 @@ also adds the following options: | Option | Type | Description | Default | | ------------------ | ------- | ---------------------------------------------------------------------------------------------- | ------- | -| `stages*` | array | Array of objects that specify the target number of VUs to ramp up or down to. | `[]` | -| `startVUs` | integer | Number of VUs to run at test start. | `1` | -| `gracefulRampDown` | string | Time to wait for an already started iteration to finish before stopping it during a ramp down. | `"30s"` | +| stages(required) | array | Array of objects that specify the target number of VUs to ramp up or down to. | `[]` | +| startVUs | integer | Number of VUs to run at test start. | `1` | +| gracefulRampDown | string | Time to wait for an already started iteration to finish before stopping it during a ramp down. | `"30s"` | ## When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/05 constant-arrival-rate.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/05 constant-arrival-rate.md index 7f5bec1f1d..4cb66f59d2 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/05 constant-arrival-rate.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/05 constant-arrival-rate.md @@ -21,11 +21,11 @@ also adds the following options: | Option | Type | Description | Default | | ------------------ | ------- | --------------------------------------------------------------------------------------- | ------- | -| `duration*` | string | Total scenario duration (excluding `gracefulStop`). | - | -| `rate*` | integer | Number of iterations to execute each `timeUnit` period. | - | -| `preAllocatedVUs*` | integer | Number of VUs to pre-allocate before test start in order to preserve runtime resources. | - | -| `timeUnit` | string | Period of time to apply the `rate` value. | `"1s"` | -| `maxVUs` | integer | Maximum number of VUs to allow during the test run. | - | +| duration(required) | string | Total scenario duration (excluding `gracefulStop`). | - | +| rate(required) | integer | Number of iterations to execute each `timeUnit` period. | - | +| preAllocatedVUs(required) | integer | Number of VUs to pre-allocate before test start in order to preserve runtime resources. | - | +| timeUnit | string | Period of time to apply the `rate` value. | `"1s"` | +| maxVUs | integer | Maximum number of VUs to allow during the test run. | - | ## When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/06 ramping-arrival-rate.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/06 ramping-arrival-rate.md index afdee9bf52..32c90c52a6 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/06 ramping-arrival-rate.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/06 ramping-arrival-rate.md @@ -18,11 +18,11 @@ also adds the following options: | Option | Type | Description | Default | | ------------------ | ------- | --------------------------------------------------------------------------------------- | ------- | -| `stages*` | array | Array of objects that specify the target number of iterations to ramp up or down to. | `[]` | -| `preAllocatedVUs*` | integer | Number of VUs to pre-allocate before test start in order to preserve runtime resources. | - | -| `startRate` | integer | Number of iterations to execute each `timeUnit` period at test start. | `0` | -| `timeUnit` | string | Period of time to apply the `startRate` the `stages` `target` value. | `"1s"` | -| `maxVUs` | integer | Maximum number of VUs to allow during the test run. | - | +| stages(required) | array | Array of objects that specify the target number of iterations to ramp up or down to. | `[]` | +| preAllocatedVUs(required) | integer | Number of VUs to pre-allocate before test start in order to preserve runtime resources. | - | +| startRate | integer | Number of iterations to execute each `timeUnit` period at test start. | `0` | +| timeUnit | string | Period of time to apply the `startRate` the `stages` `target` value. | `"1s"` | +| maxVUs | integer | Maximum number of VUs to allow during the test run. | - | ## When to use diff --git a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/07 externally-controlled.md b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/07 externally-controlled.md index 081058d0a1..f628b6d239 100644 --- a/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/07 externally-controlled.md +++ b/src/data/markdown/docs/01 guides/02 Using k6/14 Scenarios/01 Executors/07 externally-controlled.md @@ -22,9 +22,9 @@ also adds the following options: | Option | Type | Description | Default | | ----------- | ------- | --------------------------------------------------- | ------- | -| `duration*` | string | Total test duration. | - | -| `vus` | integer | Number of VUs to run concurrently. | - | -| `maxVUs` | integer | Maximum number of VUs to allow during the test run. | - | +| duration(required) | string | Total test duration. | - | +| vus | integer | Number of VUs to run concurrently. | - | +| maxVUs | integer | Maximum number of VUs to allow during the test run. | - | ## When to use