Skip to content

Adds a simple documentation structure based on Antora #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lfrancke merged 2 commits into from
Apr 30, 2021
Merged

Adds a simple documentation structure based on Antora #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee5f33d
Adds a simple documentation structure based on Antora
lfrancke Apr 30, 2021
0047581
Update docs/modules/ROOT/pages/index.adoc
lfrancke Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name: zookeeper
version: master
title: Stackable Operator for Apache ZooKeeper
nav:
- modules/ROOT/nav.adoc
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* xref:building.adoc[]
8 changes: 8 additions & 0 deletions docs/modules/ROOT/pages/building.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= 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.