From 877ae5ec851d29cff9f4445d959b086f96ec33f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de> Date: Fri, 9 Jul 2021 15:28:41 +0200 Subject: [PATCH] Minor doc fixes --- docs/creating-a-benchmark.md | 8 ++++++++ docs/running-benchmarks.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/creating-a-benchmark.md b/docs/creating-a-benchmark.md index 8e5282610..fe16672f2 100644 --- a/docs/creating-a-benchmark.md +++ b/docs/creating-a-benchmark.md @@ -1,3 +1,9 @@ + +# Defining a Benchmark + +Please note that to simply run a benchmark, it is not required to define one. Theodolite comes with a set of benchmarks, which are ready to be executed. See the Benchmarks and Executions docs page to learn more about our distinction between benchmarks and executions. + + * Create a benchmark for operator mode * Create a benchmark for standalone mode * Deploy a benchmark @@ -12,6 +18,8 @@ + + ## Creating a benchmark for standalone mode Creating a benchmark in standalone mode is similar to operator mode. However, diff --git a/docs/running-benchmarks.md b/docs/running-benchmarks.md index 1d6792a31..3cb8e30aa 100644 --- a/docs/running-benchmarks.md +++ b/docs/running-benchmarks.md @@ -20,7 +20,7 @@ automatically one after another. ## Running Benchmarks with the Theodolite Operator -The general process for running Theodolite benchmarks in standalone mode is as follows: +The general process for running Theodolite benchmarks in operator mode is as follows: 1. Create and deploy a new `Benchmark` resource or deploy one of the already existing ones. 2. Define your benchmark execution as an `Execution` resource and deploy it. -- GitLab