Merge pull request wildfly#276 from jmesnil/doc_index

Add index page for the generated documentation
yersan · Sep 6, 2023 · 0dca77b · 0dca77b
2 parents 7e1b57f + 2029579
commit 0dca77b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/doc/index.adoc 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.
diff --git 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)