diff --git a/README.md b/README.md index 39b5d41c..a05aa5ff 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ - `TestRun` CRD - `PrivateLoadZone` CRD -`TestRun` CRD is a representation of a single k6 test, executed once. `TestRun` has a large support for configuration of different options that allows you to adapt to different Kubernetes setups. Full list of options can be found in [definition itself](https://github.com/grafana/k6-operator/blob/main/config/crd/bases/k6.io_testruns.yaml). +`TestRun` CRD is a representation of a single k6 test, executed once. `TestRun` has a large support for configuration of different options that allows you to adapt to different Kubernetes setups. Full list of options can be found in the [definition itself](https://github.com/grafana/k6-operator/blob/main/config/crd/bases/k6.io_testruns.yaml). -`PrivateLoadZone` CRD is a representation of a load zone: this is a k6 term for a set of nodes within a cluster designated for k6 test runs. `PrivateLoadZone` is integrated with [Grafana Cloud k6](https://grafana.com/products/cloud/k6/) and requires a subscription. The guide to set up `PrivateLoadZone` can be found [here](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/set-up-private-load-zones/) and billing details [here](TODO). +`PrivateLoadZone` CRD is a representation of a [load zone](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/use-load-zones/): a k6 term for a set of nodes within a cluster designated to execute k6 test runs. `PrivateLoadZone` is integrated with [Grafana Cloud k6](https://grafana.com/products/cloud/k6/) and requires a subscription. There is a guide describing [how to set up `PrivateLoadZone`](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/set-up-private-load-zones/), while billing details are described [here](TODO). -Complete documentation for the k6 Operator can be found [here](TODO). Some additional resources: +Complete documentation for the k6 Operator can be found in the [Grafana docs](TODO). Some additional resources: - :book: A guide [Running distributed load tests on Kubernetes](https://grafana.com/blog/2022/06/23/running-distributed-load-tests-on-kubernetes/). - :book: A guide [Running distributed tests](https://grafana.com/docs/k6/latest/testing-guides/running-distributed-tests/). - :movie_camera: Grafana Office Hours [Load Testing on Kubernetes with k6 Private Load Zones](https://www.youtube.com/watch?v=RXLavQT58YA). -Common samples are available in `config/samples` and `e2e/`, both for the `TestRun` and for the `PrivateLoadZone`. +Common samples are available in `config/samples` and `e2e/` of this repo, both for the `TestRun` and for the `PrivateLoadZone`. ## Contributing