Skip to content

Commit 986062a

Browse files
authored
Add headings to README for clarity. (#337)
1 parent c80684e commit 986062a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,29 @@ gRPC OSS benchmarks are a collection of libraries and executables to schedule,
1616
run and monitor [gRPC performance benchmarking][benchmarking] tests on a
1717
Kubernetes cluster.
1818

19+
### Controller
20+
1921
The main executable is a [custom controller][] that manages resources of kind
2022
[LoadTest][loadtest]. This controller must be deployed to the cluster before
2123
load tests can be run on it. For deployment information, see [deployment][]. The
2224
controller is implemented with [kubebuilder][].
2325

24-
There is also a set of [tools](tools/README.md) used to generate load test
26+
[custom controller]: cmd/controller/main.go
27+
[deployment]: doc/deployment.md
28+
[kubebuilder]: https://kubebuilder.io
29+
[loadtest]: config/crd/bases/e2etest.grpc.io_loadtests.yaml
30+
31+
### Tools
32+
33+
There is a set of [tools](tools/README.md) used to generate load test
2534
configurations, prepare prebuilt images and run batches of tests. These tools
2635
are used to run batches of tests for continuous integration.
2736

37+
### Examples
38+
2839
[Examples](config/samples/README.md) of load test configurations in the
2940
supported languages are also provided.
3041

31-
[custom controller]: cmd/controller/main.go
32-
[deployment]: doc/deployment.md
33-
[kubebuilder]: https://kubebuilder.io
34-
[loadtest]: config/crd/bases/e2etest.grpc.io_loadtests.yaml
35-
3642
## Dashboard
3743

3844
The data generated in continuous integration are saved to [BigQuery][bigquery],

0 commit comments

Comments
 (0)