Merge pull request #11 from stackabletech/fix/issue-212

Fix/issue 212

Author: fhennig

preview-src/index.adoc

@@ -1,14 +1,8 @@
 = Stackable Documentation
-Author Name
-#:page-layout: landing
-:idprefix:
-:idseparator: -
-:!example-caption:
-:!table-caption:
-:page-pagination:
+:page-layout: landing
 
 Welcome to Stackable!
-This documentation gives you an overview of our platform, how to install and manage it as well as some tutorials.
+This documentation gives you an overview of the Stackable Data Platform, how to install and manage it as well as some tutorials.
 
 ++++
 <br>
@@ -26,14 +20,11 @@ This documentation gives you an overview of our platform, how to install and man
 <h3>Introduction</h3>
 ++++
 
-If you have any feedback regarding the documentation please either open an https://github.com/stackabletech/documentation/issues[issue], ask a https://github.com/stackabletech/documentation/discussions[question] or look at the source for this documentation in its https://github.com/stackabletech/documentation[repository].
-
-Our Stackable platform allows you to deploy, scale and manage Big Data infrastructure in any environment as long as it can run https://kubernetes.io/[Kubernetes].
+The Stackable Data Platform allows you to deploy, scale and manage Data infrastructure in any environment running https://kubernetes.io/[Kubernetes].
 
+You can find an overview of the supported components <<Components,below>>, as well as a full list of all supported product versions xref:operators:supported_versions.adoc[here].
 
-IMPORTANT: Our platform used to be based on a different architecture (until November 2021) where we built an alternative Kubelet. We abandoned that effort for now and are moving towards a Kubernetes-native experience using the normal `kubelet`.
-This is an ongoing effort and the documentation might not reflect reality everywhere.
-We aim to update our platform as well as the documentation by the end of 2021 and will remove this note when the migration has completed.
+If you have any feedback regarding the documentation please either open an https://github.com/stackabletech/documentation/issues[issue], ask a https://github.com/stackabletech/documentation/discussions[question] or look at the source for this documentation in its https://github.com/stackabletech/documentation[repository].
 
 ++++
 </div>
@@ -54,7 +45,7 @@ While the platform got started in the _Big Data_ ecosystem we are in no way limi
 
 You can declaratively build these environments, and we don't stop at the tool level as we also provide ways for the users to interact with the platform in the "as Code"-approach.
 
-We are leveraging the https://www.openpolicyagent.org/[OpenPolicyAgent] to provide Authorization-as-Code.
+We are leveraging the https://www.openpolicyagent.org/[Open Policy Agent] to provide Security-as-Code.
 
 We are building a distribution that includes the “best of breed” of existing Open Source tools, but bundles them in a way, so it is easy to deploy a fully working stack of software. Most of the existing tools are “single purpose” tools, which often do not play nicely together out-of-the-box.
 
@@ -70,7 +61,8 @@ We are building a distribution that includes the “best of breed” of existing
 
 We are using Kubernetes as our deployment platform.
 And we're building https://kubernetes.io/docs/concepts/extend-kubernetes/operator/[Operators] for each of the products we support.
-At the moment we support the following products (i.e. we have operators for each of those):
+
+The Stackable Data Platform supports the following products:
 
 ++++
 <br>
@@ -85,12 +77,60 @@ At the moment we support the following products (i.e. we have operators for each
 ++++
 
 ++++
-<h3>Kafka Operator</h3>
+<h3>Apache Airflow</h3>
+++++
+
+Airflow is a workflow engine and your replacement should you be using Apache Oozie.
+
+xref:airflow::index.adoc[Read more]
+
+++++
+</div>
+++++
+
+++++
+<div class="box">
+++++
+
+++++
+<h3>Apache Druid</h3>
+++++
+
+Apache Druid is a real-time database to power modern analytics applications.
+
+xref:druid::index.adoc[Read more]
+
+++++
+</div>
+++++
+
+++++
+<div class="box">
+++++
+
+++++
+<h3>Apache HBase</h3>
+++++
+
+HBase is a distributed, scalable, big data store.
+
+xref:hbase::index.adoc[Read more]
+
+++++
+</div>
+++++
+
+++++
+<div class="box">
+++++
+
+++++
+<h3>Apache Hadoop HDFS</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+HDFS is a distributed file system that provides high-throughput access to application data.
 
-link:/kafka/index.html[Read more]
+xref:hdfs::index.adoc[Read more]
 
 ++++
 </div>
@@ -101,12 +141,12 @@ link:/kafka/index.html[Read more]
 ++++
 
 ++++
-<h3>Spark Operator</h3>
+<h3>Apache Hive</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+The Apache Hive data warehouse software facilitates reading, writing, and managing large datasets residing in distributed storage using SQL. We support the Hive Metastore.
 
-link:/spark/index.html[Read more]
+xref:hive::index.adoc[Read more]
 
 ++++
 </div>
@@ -117,12 +157,12 @@ link:/spark/index.html[Read more]
 ++++
 
 ++++
-<h3>Trino Operator</h3>
+<h3>Apache Kafka</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.
 
-link:/trino/index.html[Read more]
+xref:kafka::index.adoc[Read more]
 
 ++++
 </div>
@@ -133,12 +173,12 @@ link:/trino/index.html[Read more]
 ++++
 
 ++++
-<h3>Zookeeper Operator</h3>
+<h3>Apache NiFi</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+An easy to use, powerful, and reliable system to process and distribute data.
 
-link:/zookeeper/index.html[Read more]
+xref:nifi::index.adoc[Read more]
 
 ++++
 </div>
@@ -149,12 +189,12 @@ link:/zookeeper/index.html[Read more]
 ++++
 
 ++++
-<h3>NiFi Operator</h3>
+<h3>Apache Spark</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+Apache Spark is a multi-language engine for executing data engineering, data science, and machine learning on single-node machines or clusters.
 
-link:/nifi/index.html[Read more]
+xref:spark-k8s::index.adoc[Read more]
 
 ++++
 </div>
@@ -165,17 +205,50 @@ link:/nifi/index.html[Read more]
 ++++
 
 ++++
-<h3>Superset Operator</h3>
+<h3>Apache Superset</h3>
 ++++
 
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+Apache Superset is a modern data exploration and visualization platform.
 
-link:/superset/index.html[Read more]
+xref:superset::index.adoc[Read more]
 
 ++++
 </div>
 ++++
 
+++++
+<div class="box">
+++++
+
+++++
+<h3>Trino</h3>
+++++
+
+Fast distributed SQL query engine for big data analytics that helps you explore your data universe.
+
+xref:trino::index.adoc[Read more]
+
+++++
+</div>
+++++
+
+++++
+<div class="box">
+++++
+
+++++
+<h3>Apache ZooKeeper</h3>
+++++
+
+ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.
+
+xref:zookeeper::index.adoc[Read more]
+
+++++
+</div>
+++++
+
+
 ++++
 </div>
 ++++

src/css/main.css

@@ -1,3 +1,7 @@
+main {
+  min-width: 0; /* min-width: 0 required for flexbox to constrain overflowing elements */
+}
+
 @media screen and (max-width: 1023.5px) {
   aside.toc.sidebar {
     display: none;
@@ -11,7 +15,6 @@
 @media screen and (min-width: 1024px) {
   main {
     flex: auto;
-    min-width: 0; /* min-width: 0 required for flexbox to constrain overflowing elements */
   }
 
   main > .content {

src/css/nav.css

@@ -256,3 +256,19 @@ html.is-clipped--nav {
   opacity: 0.9;
   font-weight: var(--body-font-weight-bold);
 }
+
+.nav-menu .title-wrapper {
+  display: flex;
+}
+
+.nav-menu .title-wrapper h3 {
+  flex-grow: 2;
+}
+
+.nav-menu .title-wrapper .page-versions {
+  flex-grow: 1;
+  min-width: 85px;
+  margin-right: 0;
+  margin-left: 5px;
+  text-align: end;
+}

src/css/search.css

@@ -14,7 +14,7 @@
   background-color: #474d57;
   font-family: inherit;
   font-size: 0.95rem;
-  width: 150px;
+  width: 120px;
   border: none;
   line-height: 1.5;
   padding: 4px 20px;
@@ -29,6 +29,12 @@
   outline: none;
 }
 
+@media screen and (min-width: 500px) {
+  #search-input {
+    width: 150px;
+  }
+}
+
 @media screen and (min-width: 769px) {
   #search-input {
     width: 200px;

src/partials/header-content.hbs

@@ -7,7 +7,7 @@
       {{#if env.SITE_SEARCH_PROVIDER}}
       <div class="navbar-item search hide-for-print">
         <div id="search-field" class="field">
-          <input id="search-input" type="text" placeholder="Search the docs"{{#if page.home}} autofocus{{/if}}>
+          <input id="search-input" type="text" placeholder="Search..."{{#if page.home}} autofocus{{/if}}>
         </div>
       </div>
       {{/if}}

src/partials/nav-menu.hbs

@@ -1,10 +1,24 @@
 {{#with page.navigation}}
 <div class="nav-panel-menu is-active" data-panel="menu">
   <nav class="nav-menu">
-    {{#with @root.page.componentVersion}}
-    <h3 class="title"><a href="{{{relativize ./url}}}">{{./title}}</a></h3>
-    {{/with}}
-{{> nav-tree navigation=this}}
+    <div class="title-wrapper">
+      {{#with @root.page.componentVersion}}
+      <h3 class="title"><a href="{{{relativize ./url}}}">{{./title}}</a></h3>
+      {{/with}}
+      {{#with @root.page.versions}}
+      <div class="page-versions">
+        <button class="version-menu-toggle" title="Show other versions of page">{{@root.page.componentVersion.displayVersion}}</button>
+        <div class="version-menu">
+          {{#each this}}
+          <a class="version
+            {{~#if (eq ./version @root.page.version)}} is-current{{/if~}}
+            {{~#if ./missing}} is-missing{{/if}}" href="{{{relativize ./url}}}">{{./displayVersion}}</a>
+          {{/each}}
+        </div>
+      </div>
+      {{/with}}
+    </div>
+    {{> nav-tree navigation=this}}
   </nav>
 </div>
 {{/with}}

src/partials/page-versions.hbs

@@ -4,7 +4,6 @@
   <a href="{{{relativize this}}}" class="home-link{{#if @root.page.home}} is-current{{/if}}"></a>
   {{/with}}
 {{> breadcrumbs}}
-{{> page-versions}}
   {{#if (and page.fileUri (not env.CI))}}
   <div class="edit-this-page"><a href="{{page.fileUri}}">Edit this Page</a></div>
   {{else if (and page.editUrl (or env.FORCE_SHOW_EDIT_PAGE_LINK (not page.origin.private)))}}