Skip to content

Commit 9aef773

Browse files
heitortsergentheitortsergent
authored
chore: remove noindex from Grafana docs (#1446)
* chore: remove noindex from grafana docs Keep noindex on a few pages that will be updated later on * chore: backport to v0.48 * chore: backport to v0.47
1 parent 9040dce commit 9aef773

File tree

13 files changed

+42
-25
lines changed

13 files changed

+42
-25
lines changed

‎docs/sources/_index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ cascade:
1111
labels:
1212
products:
1313
- oss
14-
noindex: true
1514
breadcrumb_start: 4
1615
search_section: Grafana k6
1716
search_type: doc

‎docs/sources/next/examples/_index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
weight: 11
32
title: Examples
3+
weight: 11
4+
noindex: true
45
---
56

67
# Examples

‎docs/sources/next/testing-guides/api-load-testing.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'API load testing'
33
head_title: 'Intro to API Load Testing: The k6 Guide'
44
excerpt: 'Load testing APIs has many facets. This guide introduces you to performance testing and provides best practices to load test your APIs with k6.'
55
weight: 01
6+
noindex: true
67
---
78

89
# API load testing
@@ -106,7 +107,7 @@ But, even in this case, sleep can help you avoid overworking the load generator,
106107

107108
When testing the API against normal, human-run workflows, add sleep as in a normal test.
108109

109-
{{% /admonition %}}
110+
{{% /admonition %}}
110111

111112
### Virtual users
112113

‎docs/sources/next/testing-guides/load-testing-websites.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'Load testing websites'
33
head_title: 'How to Load Test a Website: The k6 Guide'
44
excerpt: 'Do you know how many users your site can handle? This guide answers the WHY and WHEN you should load test your website and gives you the best practices for load testing websites or web apps with k6. Let’s get started.'
55
weight: 03
6+
noindex: true
67
---
78

89
# Load testing websites
@@ -206,7 +207,9 @@ export default async function () {
206207
sleep(4);
207208

208209
// 02. View products
209-
const element = page.locator('a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]');
210+
const element = page.locator(
211+
'a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]'
212+
);
210213
await element.click();
211214
page.waitForSelector('button[name="add-to-cart"]');
212215
page.screenshot({ path: 'screenshots/02_view-product.png' });
@@ -341,6 +344,5 @@ Load testing websites can be complex due to the number of viable testing approac
341344
- [Browser testing with k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/)
342345
- [Load test types](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/)
343346
- [Session recording guide](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-authoring/create-tests-from-recordings/)
344-
- [Determining concurrent users in your load tests]
345-
(https://k6.io/blog/monthly-visits-concurrent-users)
347+
- [Determining concurrent users in your load tests](https://k6.io/blog/monthly-visits-concurrent-users)
346348
- [Data correlation in your test script](https://grafana.com/docs/k6/<K6_VERSION>/examples/correlation-and-dynamic-data)

‎docs/sources/next/testing-guides/test-types/_index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Load test types'
33
excerpt: 'A series of conceptual articles explaining the different types of load tests. Learn about planning, running, and interpreting different tests for different performance goals.'
44
weight: -10
5+
cascade:
6+
noindex: true
57
---
68

79
# Load test types
@@ -38,14 +40,14 @@ The main types are as follows. Each type has its own article outlining its essen
3840

3941
In k6 scripts, configure the load configuration using [`options`](https://grafana.com/docs/k6/<K6_VERSION>/get-started/running-k6#using-options) or [`scenarios`](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios). This separates workload configuration from iteration logic.
4042

41-
{{% /admonition %}}
43+
{{% /admonition %}}
4244

4345
## Test-type cheat sheet
4446

4547
The following table provides some broad comparisons.
4648

47-
| Type | VUs/Throughput | Duration | When? |
48-
| --------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
49+
| Type | VUs/Throughput | Duration | When? |
50+
| --------------------------------------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
4951
| [Smoke](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/smoke-testing) | Low | Short (seconds or minutes) | When the relevant system or application code changes. It checks functional logic, baseline metrics, and deviations |
5052
| [Load](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/load-testing) | Average production | Mid (5-60 minutes) | Often to check system maintains performance with average use |
5153
| [Stress](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/stress-testing) | High (above average) | Mid (5-60 minutes) | When system may receive above-average loads to check how it manages |

‎docs/sources/v0.47.x/examples/_index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
weight: 11
32
title: Examples
3+
weight: 11
4+
noindex: true
45
---
56

67
# Examples

‎docs/sources/v0.47.x/testing-guides/api-load-testing.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'API load testing'
33
head_title: 'Intro to API Load Testing: The k6 Guide'
44
excerpt: 'Load testing APIs has many facets. This guide introduces you to performance testing and provides best practices to load test your APIs with k6.'
55
weight: 01
6+
noindex: true
67
---
78

89
# API load testing
@@ -106,7 +107,7 @@ But, even in this case, sleep can help you avoid overworking the load generator,
106107

107108
When testing the API against normal, human-run workflows, add sleep as in a normal test.
108109

109-
{{% /admonition %}}
110+
{{% /admonition %}}
110111

111112
### Virtual users
112113

‎docs/sources/v0.47.x/testing-guides/load-testing-websites.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'Load testing websites'
33
head_title: 'How to Load Test a Website: The k6 Guide'
44
excerpt: 'Do you know how many users your site can handle? This guide answers the WHY and WHEN you should load test your website and gives you the best practices for load testing websites or web apps with k6. Let’s get started.'
55
weight: 03
6+
noindex: true
67
---
78

89
# Load testing websites
@@ -206,7 +207,9 @@ export default async function () {
206207
sleep(4);
207208

208209
// 02. View products
209-
const element = page.locator('a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]');
210+
const element = page.locator(
211+
'a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]'
212+
);
210213
await element.click();
211214
page.waitForSelector('button[name="add-to-cart"]');
212215
page.screenshot({ path: 'screenshots/02_view-product.png' });
@@ -341,6 +344,5 @@ Load testing websites can be complex due to the number of viable testing approac
341344
- [Browser testing with k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/)
342345
- [Load test types](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/)
343346
- [Session recording guide](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-authoring/create-tests-from-recordings/)
344-
- [Determining concurrent users in your load tests]
345-
(https://k6.io/blog/monthly-visits-concurrent-users)
347+
- [Determining concurrent users in your load tests](https://k6.io/blog/monthly-visits-concurrent-users)
346348
- [Data correlation in your test script](https://grafana.com/docs/k6/<K6_VERSION>/examples/correlation-and-dynamic-data)

‎docs/sources/v0.47.x/testing-guides/test-types/_index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Load test types'
33
excerpt: 'A series of conceptual articles explaining the different types of load tests. Learn about planning, running, and interpreting different tests for different performance goals.'
44
weight: -10
5+
cascade:
6+
noindex: true
57
---
68

79
# Load test types
@@ -38,14 +40,14 @@ The main types are as follows. Each type has its own article outlining its essen
3840

3941
In k6 scripts, configure the load configuration using [`options`](https://grafana.com/docs/k6/<K6_VERSION>/get-started/running-k6#using-options) or [`scenarios`](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios). This separates workload configuration from iteration logic.
4042

41-
{{% /admonition %}}
43+
{{% /admonition %}}
4244

4345
## Test-type cheat sheet
4446

4547
The following table provides some broad comparisons.
4648

47-
| Type | VUs/Throughput | Duration | When? |
48-
| --------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
49+
| Type | VUs/Throughput | Duration | When? |
50+
| --------------------------------------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
4951
| [Smoke](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/smoke-testing) | Low | Short (seconds or minutes) | When the relevant system or application code changes. It checks functional logic, baseline metrics, and deviations |
5052
| [Load](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/load-testing) | Average production | Mid (5-60 minutes) | Often to check system maintains performance with average use |
5153
| [Stress](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/stress-testing) | High (above average) | Mid (5-60 minutes) | When system may receive above-average loads to check how it manages |

‎docs/sources/v0.48.x/examples/_index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
weight: 11
32
title: Examples
3+
weight: 11
4+
noindex: true
45
---
56

67
# Examples

0 commit comments

Comments
 (0)