Add release notes (#223)

* Added release notes for release 22/06 Co-authored-by: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com> Co-authored-by: Lars Francke <lars.francke@gmail.com>

Author: 3 people

antora.yml

@@ -7,4 +7,5 @@ nav:
  - modules/tutorials/nav.adoc
  - modules/reference/nav.adoc
  - modules/operators/nav.adoc
- - modules/contributor/nav.adoc
+ - modules/contributor/nav.adoc
+ - modules/ROOT/nav2.adoc

modules/ROOT/nav.adoc

@@ -1,2 +1,2 @@
 * xref:quickstart.adoc[]
-* xref:getting_started.adoc[]
+* xref:getting_started.adoc[]

modules/ROOT/nav2.adoc

@@ -0,0 +1,3 @@
+// This second nav file is for another menu entry at the end of the navigation menu
+// see: https://docs.antora.org/antora/3.0/navigation/organize-files/#multiple-files-per-module
+* xref:release_notes.adoc[Release Notes]

modules/ROOT/pages/index.adoc

@@ -4,6 +4,16 @@
 Welcome to Stackable!
 This documentation gives you an overview of the Stackable Data Platform, how to install and manage it as well as some tutorials.
 
+
+[NOTE]
+.Our first release - June 2022
+====
+We are proud to announce our first public release!
+
+Please read the xref:release_notes.adoc[release notes] to read up on the details.
+====
+
+
 ++++
 <br>
 ++++

modules/ROOT/pages/release_notes.adoc

@@ -0,0 +1,100 @@
+= Release notes for the Stackable Data Platform
+
+The Stackable platform consists of multiple operators that work together.
+Periodically a platform release is made, including all components of the platform at a specific version.
+
+
+== Release 22.06
+
+This is our first release of the Stackable Data Platform, bringing Kubernetes operators for 12 products as well as <<stackablectl>>, the commandline tool to easily install data products in Kubernetes.
+Operators spin up production ready product applications.
+Also, there are some common features across all operators, such as monitoring, service discovery and configuration overrides.
+Find the <<Platform features>>, <<stackablectl,stackablectl features>> and <<operators>> below.
+
+Please report any issues you find in the specific operator repositories or in our dedicated github.com/stackabletech/issues/[issues] repository.
+You may also join us in our https://slack.stackable.tech[Slack] community or https://stackable.tech[contact us via our homepage].
+
+While we are very proud of this release it is our first one and we'll add new features and fix bugs all the time and will have regular releases from now on.
+
+=== Platform features
+
+Easily install production ready data applications::
+Using a familiar declarative approach, users can easily install data applications such as Apache Kafka or Trino across multiple cloud Kubernetes providers or on their own data centers.
+The installation process is fully automated while also providing the flexibility for the user to tune relevant aspects of each application.
+
+Monitoring::
+All products have monitoring with prometheus enabled.
+//
+xref:operators:monitoring.adoc[Learn more]
+
+Service discovery::
+Products on the Stackable platform use service discovery to easily interconnect with each other.
+//
+xref:concepts:service_discovery.adoc[Learn more]
+
+Configuration overrides::
+All operators support configuration overrides, these are documented in the specific operator documentation pages.
+
+Common S3 configuration::
+Many products support connecting to S3 to load and/or store data.
+There is a common resource for S3 connections and buckets across all operators that can be reused.
+//
+xref:concepts:s3.adoc[Learn more]
+
+Roles and role groups::
+To support hybrid hardware clusters, the Stackable platform uses the concept of role groups.
+Services and applications can be configured to maximize hardware efficiency.
+
+Standardized::
+Learn once reuse everywhere.
+We use the same conventions in all our operators.
+Configure your LDAP or S3 connections once and reuse them everywhere.
+All our operators reuse the same CRD structure as well.
+
+[#stackablectl]
+=== stackablectl
+
+`stackablectl` is used to install and interact with the operators, either individually or with multiple at once.
+//
+xref:stackablectl::index.adoc[Learn more]
+
+[#operators]
+=== Operators
+
+This is the list of all operators in this current release, with their versions for this release.
+
+.*Products*
+* xref:airflow::index.adoc[] (0.4.0)
+** Load DAGs from ConfigMaps or PersistentVolumeClaims
+* xref:druid::index.adoc[] (0.6.0)
+** S3 and HDFS as deep storage options
+** ingestion from S3 buckets
+** authorization using OPA
+* xref:hbase::index.adoc[] (0.3.0)
+* xref:hdfs::index.adoc[] (0.4.0)
+* xref:hive::index.adoc[] (0.6.0)
+** Hive Metastore can index S3
+* xref:kafka::index.adoc[] (0.6.0)
+** Seamless integration with NiFi and Druid
+** Supports OPA authorization
+* xref:nifi::index.adoc[] (0.6.0)
+* xref:spark-k8s::index.adoc[] (0.3.0)
+* xref:superset::index.adoc[] (0.5.0)
+** connects to Druid as a backend
+** Supports LDAP authentication
+* xref:trino::index.adoc[] (0.4.0)
+** Supports OPA and file-based authorization
+** Connects to the Hive Metastore
+** Query data from S3
+** TLS support
+* xref:zookeeper::index.adoc[] (0.10.0)
+** Supports creating ZNodes with CRDs
+
+Read up on the xref:operators:supported_versions.adoc[supported versions] for each of these products.
+
+.*Supporting operators*
+* xref:opa::index.adoc[] (0.9.0)
+** Create RegoRules in ConfigMaps
+* xref:commons-operator::index.adoc[] (0.2.0)
+* xref:secret-operator::index.adoc[] (0.5.0)
+

modules/contributor/pages/service_discovery.adoc

@@ -7,11 +7,11 @@ For a conceptual overview of service discovery, consult the xref:concepts:servic
 
 == Best practices
 
-==== Exposing config maps for service discovery
+=== Exposing config maps for service discovery
 
 The question about which interfaces to expose varies from product to product and must be decided on an individual basis. However, as far as possible the exposed services should be reachable via Kubernetes services like `ClusterIP` or `NodePort`.
 
-==== Consuming config maps for service discovery
+=== Consuming config maps for service discovery
 
 The operator that discovers a service has two options for retrieving the information and providing it into the pods:
 

modules/tutorials/nav.adoc

@@ -1,3 +1,2 @@
-* Tutorials
-
+* xref:tutorials:index.adoc[]
 ** xref:end-to-end_data_pipeline_example.adoc[]

modules/tutorials/pages/index.adoc

@@ -0,0 +1,3 @@
+= Tutorials
+
+In this section you'll find tutorials that take you through a series of steps to complete a concrete project.