From 42d87e4d5639142b3ef8435284f25bb4a724c5cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de> Date: Thu, 4 Feb 2021 15:31:54 +0100 Subject: [PATCH] Add initial template for docs --- docs/README.md | 19 +++++++++++++++++++ docs/_config.yml | 4 ++++ docs/release-process.md | 6 ++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/_config.yml diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..6ad1dd576 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +# Theodolite + +> A theodolite is a precision optical instrument for measuring angles between designated visible points in the horizontal and vertical planes. -- <cite>[Wikipedia](https://en.wikipedia.org/wiki/Theodolite)</cite> + +Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines. It consists of three modules: + +## Theodolite Benchmarks + +Theodolite contains 4 application benchmarks, which are based on typical use cases for stream processing within microservices. For each benchmark, a corresponding workload generator is provided. Currently, this repository provides benchmark implementations for Kafka Streams. + + +## Theodolite Execution Framework + +Theodolite aims to benchmark scalability of stream processing engines for real use cases. Microservices that apply stream processing techniques are usually deployed in elastic cloud environments. Hence, Theodolite's cloud-native benchmarking framework deploys as components in a cloud environment, orchestrated by Kubernetes. More information on how to execute scalability benchmarks can be found in [Thedolite execution framework](execution). + + +## Theodolite Analysis Tools + +Theodolite's benchmarking method create a *scalability graph* allowing to draw conclusions about the scalability of a stream processing engine or its deployment. A scalability graph shows how resource demand evolves with an increasing workload. Theodolite provides Jupyter notebooks for creating such scalability graphs based on benchmarking results from the execution framework. More information can be found in [Theodolite analysis tool](analysis). diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..2c646915b --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,4 @@ +title: "Theodolite" +remote_theme: pmarsceill/just-the-docs +#color_scheme: "dark" +#search_enabled: false \ No newline at end of file diff --git a/docs/release-process.md b/docs/release-process.md index f267d611f..c53ea4423 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -1,3 +1,9 @@ +--- +title: Release Process +has_children: false +nav_order: 2 +--- + # Release Process We assume that we are creating the release `v0.1.1`. Please make sure to adjust -- GitLab