Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove noindex from Grafana docs #1446

Merged
merged 3 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ cascade:
labels:
products:
- oss
noindex: true
breadcrumb_start: 4
search_section: Grafana k6
search_type: doc
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/next/examples/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
weight: 11
title: Examples
weight: 11
noindex: true
---

# Examples
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/next/testing-guides/api-load-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'API load testing'
head_title: 'Intro to API Load Testing: The k6 Guide'
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.'
weight: 01
noindex: true
---

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

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

{{% /admonition %}}
{{% /admonition %}}

### Virtual users

Expand Down
8 changes: 5 additions & 3 deletions docs/sources/next/testing-guides/load-testing-websites.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'Load testing websites'
head_title: 'How to Load Test a Website: The k6 Guide'
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.'
weight: 03
noindex: true
---

# Load testing websites
Expand Down Expand Up @@ -206,7 +207,9 @@ export default async function () {
sleep(4);

// 02. View products
const element = page.locator('a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]');
const element = page.locator(
'a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]'
);
await element.click();
page.waitForSelector('button[name="add-to-cart"]');
page.screenshot({ path: 'screenshots/02_view-product.png' });
Expand Down Expand Up @@ -341,6 +344,5 @@ Load testing websites can be complex due to the number of viable testing approac
- [Browser testing with k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/)
- [Load test types](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/)
- [Session recording guide](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-authoring/create-tests-from-recordings/)
- [Determining concurrent users in your load tests]
(https://k6.io/blog/monthly-visits-concurrent-users)
- [Determining concurrent users in your load tests](https://k6.io/blog/monthly-visits-concurrent-users)
- [Data correlation in your test script](https://grafana.com/docs/k6/<K6_VERSION>/examples/correlation-and-dynamic-data)
8 changes: 5 additions & 3 deletions docs/sources/next/testing-guides/test-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: 'Load test types'
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.'
weight: -10
cascade:
noindex: true
---

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

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.

{{% /admonition %}}
{{% /admonition %}}

## Test-type cheat sheet

The following table provides some broad comparisons.

| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [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 |
| [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 |
| [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 |
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/v0.47.x/examples/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
weight: 11
title: Examples
weight: 11
noindex: true
---

# Examples
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/v0.47.x/testing-guides/api-load-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'API load testing'
head_title: 'Intro to API Load Testing: The k6 Guide'
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.'
weight: 01
noindex: true
---

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

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

{{% /admonition %}}
{{% /admonition %}}

### Virtual users

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'Load testing websites'
head_title: 'How to Load Test a Website: The k6 Guide'
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.'
weight: 03
noindex: true
---

# Load testing websites
Expand Down Expand Up @@ -206,7 +207,9 @@ export default async function () {
sleep(4);

// 02. View products
const element = page.locator('a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]');
const element = page.locator(
'a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]'
);
await element.click();
page.waitForSelector('button[name="add-to-cart"]');
page.screenshot({ path: 'screenshots/02_view-product.png' });
Expand Down Expand Up @@ -341,6 +344,5 @@ Load testing websites can be complex due to the number of viable testing approac
- [Browser testing with k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/)
- [Load test types](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/)
- [Session recording guide](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-authoring/create-tests-from-recordings/)
- [Determining concurrent users in your load tests]
(https://k6.io/blog/monthly-visits-concurrent-users)
- [Determining concurrent users in your load tests](https://k6.io/blog/monthly-visits-concurrent-users)
- [Data correlation in your test script](https://grafana.com/docs/k6/<K6_VERSION>/examples/correlation-and-dynamic-data)
8 changes: 5 additions & 3 deletions docs/sources/v0.47.x/testing-guides/test-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: 'Load test types'
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.'
weight: -10
cascade:
noindex: true
---

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

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.

{{% /admonition %}}
{{% /admonition %}}

## Test-type cheat sheet

The following table provides some broad comparisons.

| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [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 |
| [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 |
| [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 |
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/v0.48.x/examples/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
weight: 11
title: Examples
weight: 11
noindex: true
---

# Examples
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/v0.48.x/testing-guides/api-load-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'API load testing'
head_title: 'Intro to API Load Testing: The k6 Guide'
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.'
weight: 01
noindex: true
---

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

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

{{% /admonition %}}
{{% /admonition %}}

### Virtual users

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'Load testing websites'
head_title: 'How to Load Test a Website: The k6 Guide'
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.'
weight: 03
noindex: true
---

# Load testing websites
Expand Down Expand Up @@ -206,7 +207,9 @@ export default async function () {
sleep(4);

// 02. View products
const element = page.locator('a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]');
const element = page.locator(
'a[class="woocommerce-LoopProduct-link woocommerce-loop-product__link"]'
);
await element.click();
page.waitForSelector('button[name="add-to-cart"]');
page.screenshot({ path: 'screenshots/02_view-product.png' });
Expand Down Expand Up @@ -341,6 +344,5 @@ Load testing websites can be complex due to the number of viable testing approac
- [Browser testing with k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/)
- [Load test types](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/)
- [Session recording guide](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-authoring/create-tests-from-recordings/)
- [Determining concurrent users in your load tests]
(https://k6.io/blog/monthly-visits-concurrent-users)
- [Determining concurrent users in your load tests](https://k6.io/blog/monthly-visits-concurrent-users)
- [Data correlation in your test script](https://grafana.com/docs/k6/<K6_VERSION>/examples/correlation-and-dynamic-data)
8 changes: 5 additions & 3 deletions docs/sources/v0.48.x/testing-guides/test-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: 'Load test types'
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.'
weight: -10
cascade:
noindex: true
---

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

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.

{{% /admonition %}}
{{% /admonition %}}

## Test-type cheat sheet

The following table provides some broad comparisons.

| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Type | VUs/Throughput | Duration | When? |
| --------------------------------------------------------------------------------------------------- | --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [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 |
| [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 |
| [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 |
Expand Down
Loading