From ee5f33dfb08796d489358729bfad4c2c7f0ccb8b Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Fri, 30 Apr 2021 09:28:07 +0200 Subject: [PATCH 1/2] Adds a simple documentation structure based on Antora --- docs/antora.yml | 5 +++++ docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/building.adoc | 8 ++++++++ docs/modules/ROOT/pages/index.adoc | 6 ++++++ 4 files changed, 20 insertions(+) create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/nav.adoc create mode 100644 docs/modules/ROOT/pages/building.adoc create mode 100644 docs/modules/ROOT/pages/index.adoc diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 00000000..e32530f0 --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,5 @@ +name: zookeeper +version: master +title: Stackable Operator for Apache ZooKeeper +nav: + - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 00000000..4f486ffb --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1 @@ +* xref:building.adoc[] diff --git a/docs/modules/ROOT/pages/building.adoc b/docs/modules/ROOT/pages/building.adoc new file mode 100644 index 00000000..02509b30 --- /dev/null +++ b/docs/modules/ROOT/pages/building.adoc @@ -0,0 +1,8 @@ += Building the Operator + +This operator is written in Rust. +It is developed against the latest Rust release (1.50.0-nightly at the time of writing). + +NOTE: This requires Rust nightly due to the use of the `backtrace` feature. + + cargo build diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..ef2af4fd --- /dev/null +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,6 @@ += Stackable Operator for Apache ZooKeeper + +This is an operator for Kubernetes that can manage https://zookeeper.apache.org/[Apache ZooKeeper] ensembles. + +WARNING: This operator does _not_ work with containers/container images. It relies on the https://github.com/stackabletech/agent/[Stackable Agent] to run on "bare metal" via systemd + From 0047581015028f33a4cce876cd58de6c8f79fda8 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Fri, 30 Apr 2021 10:03:48 +0200 Subject: [PATCH 2/2] Update docs/modules/ROOT/pages/index.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sönke Liebau --- docs/modules/ROOT/pages/index.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index ef2af4fd..08b7960d 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -2,5 +2,4 @@ This is an operator for Kubernetes that can manage https://zookeeper.apache.org/[Apache ZooKeeper] ensembles. -WARNING: This operator does _not_ work with containers/container images. It relies on the https://github.com/stackabletech/agent/[Stackable Agent] to run on "bare metal" via systemd - +WARNING: This operator does _not_ work with containers/container images. It relies on the https://github.com/stackabletech/agent/[Stackable Agent] to run on "bare metal" via systemd.