From 2029579cf4be7331f1d227360e005e584d40b5d6 Mon Sep 17 00:00:00 2001 From: Jeff Mesnil Date: Wed, 6 Sep 2023 12:25:08 +0200 Subject: [PATCH] Add index page for the generated documentation Signed-off-by: Jeff Mesnil --- doc/index.adoc | 16 ++++++++++++++++ doc/user-guide.adoc | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 doc/index.adoc diff --git a/doc/index.adoc b/doc/index.adoc new file mode 100644 index 00000000..1eb2a08a --- /dev/null +++ b/doc/index.adoc @@ -0,0 +1,16 @@ += WildFly Operator - Documentation +:toc: left + + +== WildFly Operator for Kubernetes/OpenShift + +The WildFly Operator for Kubernetes provides easy monitoring and configuration for Java applications deployed on WildFly application server using the Source-to-Image (S2I) template for WildFly. + +Once installed, the WildFly Operator provides the following features: + +* Create/Destroy: Easily launch an application deployed on WildFly +* Simple Configuration: Configure the fundamentals of WildFly-based application including number of nodes, application image, etc. + +The WildFly Operator defines a `WildFlyServer` custom resource definition (CRD) to control the behaviour of the deployed appliction. The xref:apis.adoc[API documentation] provides a full description of its capabilities. + +The xref:user-guide.adoc[User Guide] showcases various features and capabilities provides by the WildFly Operator. \ No newline at end of file diff --git a/doc/user-guide.adoc b/doc/user-guide.adoc index 49c10139..6bf55e41 100644 --- a/doc/user-guide.adoc +++ b/doc/user-guide.adoc @@ -3,7 +3,7 @@ This guide documents the various features and capabilities provides by the WildFly Operator. -This guide is complemented by the link:./apis.adoc[API Documentation]. +This guide is complemented by the xref:./apis.adoc[API Documentation]. [[basic-install]] == Basic Install (Phase I)