Add docs for streams-bootstrap

bakdata · Jan 8, 2024 · 7c92421 · 7c92421
1 parent 45c58d8
commit 7c92421
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/docs/user/core-concepts/components/streams-bootstrap.md b/docs/docs/user/core-concepts/components/streams-bootstrap.md
@@ -0,0 +1,25 @@
+# StreamsApp
+
+Subclass of [_HelmApp_](helm-app.md).
+
+### Usage
+
+Configures a Helm app with [streams-bootstrap Helm charts](https://github.com/bakdata/streams-bootstrap){target=_blank}.
+
+### Operations
+
+#### deploy
+
+Deploy using Helm.
+
+#### destroy
+
+Uninstall Helm release.
+
+#### reset
+
+Do nothing.
+
+#### clean
+
+Do nothing.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -95,6 +95,7 @@ nav:
               - Overview: user/core-concepts/components/overview.md
               - KubernetesApp: user/core-concepts/components/kubernetes-app.md
               - HelmApp: user/core-concepts/components/helm-app.md
+              - StreamsBootstrap: user/core-concepts/components/streams-bootstrap.md
               - KafkaApp: user/core-concepts/components/kafka-app.md
               - StreamsApp: user/core-concepts/components/streams-app.md
               - ProducerApp: user/core-concepts/components/producer-app.md