feat: add new doc indexes and assets

This change updates our docs to further enhance navigation and layout. Signed-off-by: Kevin Carter <[email protected]>
rackerlabs · Mar 7, 2024 · 27c941f · 27c941f
1 parent 821fa4c
commit 27c941f
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 36 deletions.
diff --git a/docs/assets/images/genestack-cropped-small.png b/docs/assets/images/genestack-cropped-small.png
diff --git a/docs/assets/images/genestack-logo-mono.png b/docs/assets/images/genestack-logo-mono.png
diff --git a/docs/assets/images/genestack-logo.png b/docs/assets/images/genestack-logo.png
diff --git a/docs/assets/images/genstack-local-arch-k8s-flex.svg b/docs/assets/images/genstack-local-arch-k8s-flex.svg
diff --git a/docs/assets/images/openstack-dysto-tall.png b/docs/assets/images/openstack-dysto-tall.png
diff --git a/docs/assets/images/openstack-dysto.jpg b/docs/assets/images/openstack-dysto.jpg
diff --git a/docs/assets/images/pngegg.png b/docs/assets/images/pngegg.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,23 @@
 # Welcome to the Genestack Documentation
 
+![Genestack Logo Mono](assets/images/genestack-logo.png#only-dark){ align=left }
+![Genestack Logo Mono](assets/images/genestack-logo-mono.png#only-light){ align=left }
+
+!!! info "The etymology of our Stack"
+
+    Genestack - dʒen.ə.stæk
+
+    1. The genesis of cloud
+    2. Open-Infrastructure Simplified
+    3. Your new favorite OpenStack ecosystem
+
 Genestack — where Kubernetes and OpenStack tango in the cloud. Imagine a waltz between systems that deploy
 what you need. Operators play the score, managing the complexity with a flick of their digital batons. They
 unify the chaos, making scaling and management a piece of cake. Think of it like a conductor effortlessly
 guiding a cacophony into a symphony.
+
+## What is Genestack?
+
+Genestack is a complete operations and deployment ecosystem for Kubernetes and OpenStack. The purpose is of
+this project is to allow hobbyists, operators, and cloud service providers the ability to build, scale, and
+leverage Open-Infrastructure in new and exciting ways.
diff --git a/docs/infrastructure-overview.md b/docs/infrastructure-overview.md
@@ -2,6 +2,13 @@
 
 [![asciicast](https://asciinema.org/a/629790.svg)](https://asciinema.org/a/629790)
 
-# Running the infrastructure deployment
 
-The infrastructure deployment can almost all be run in parallel. The above demo does everything serially to keep things consistent and easy to understand but if you just need to get things done, feel free to do it all at once.
+## Infrastructure Overview
+
+![Genestack Infra](assets/images/genstack-local-arch-k8s-flex.svg)
+
+The full scale Genestack infrastructure is bound to change over time, however, the idea is to keep things simple and transparent. The above graphic highlights how we deploy our environments and what the overall makeup of our platforms are expected to look like.
+
+!!! tip
+
+    The infrastructure deployment can almost all be run in parallel. The above demo does everything serially to keep things consistent and easy to understand but if you just need to get things done, feel free to do it all at once.
diff --git a/docs/openstack-overview.md b/docs/openstack-overview.md
@@ -13,11 +13,15 @@ The following examples all assume the use of a production environment, however,
 
 ## The DNA of our services
 
-The DNA of the OpenStack services has been built to scale, and be managed in a pseudo light-outs environment. We're aiming to empower operators to do more, simply and easily. Here are the high-level talking points about the way we've structured our applications.
+![Genestack Logo Mono](assets/images/genestack-logo.png#only-dark){ align=left }
+![Genestack Logo Mono](assets/images/genestack-logo-mono.png#only-light){ align=left }
+The DNA of the OpenStack services has been built to scale, and be managed in a pseudo light-outs environment. We're aiming to empower operators to do more, simply and easily. The high level tenets we started our project from are simple and were written with intention. We're building Genestack not to show off how complex our platform is or how smart our engineers are, we're building systems to show how simple cloud deployment, operations, and maintenance can be.
 
+### Core Tenets
 * All services make use of our core infrastructure which is all managed by operators.
+    * Rollback and versioning is present and a normal feature of our operations.
 * Backups, rollbacks, and package management all built into our applications delivery.
-* Databases, users, and grants are all run against a MariaDB Galera cluster which is setup for OpenStack to use a single right, and read from many.
-  * The primary node is part of application service discovery and will be automatically promoted / demoted within the cluster as needed.
-* Queues, permissions, vhosts, and users are all backed by a RabbitMQ cluster with automatic failover. All of the queues deployed in the environment are done with Quorum queues, giving us a best of bread queing platform which gracefully recovers from faults while maintaining performance.
+* Databases, users, and grants are all run against a cluster which is setup for OpenStack to use a single right, and read from many.
+    * The primary node is part of application service discovery and will be automatically promoted / demoted within the cluster as needed.
+* Queues, permissions, vhosts, and users are all backed by a cluster with automatic failover. All of the queues deployed in the environment are done with Quorum queues, giving us a best of bread queing platform which gracefully recovers from faults while maintaining performance.
 * Horizontal scaling groups have been applied to all of our services. This means we'll be able to auto scale API applications up and down based on the needs of the environment.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,8 +5,8 @@ site_description: >-
 
 theme:
       name: material
-      logo: assets/images/genestack.svg
-      favicon: assets/images/favicon.ico
+      logo: assets/images/genestack-logo.png
+      favicon: assets/images/pngegg.png
       palette:
             - media: "(prefers-color-scheme: light)"
               scheme: default
@@ -24,14 +24,12 @@ theme:
             - content.action.edit
             - content.code.annotate
             - content.code.copy
-            # - content.tabs.link
             - content.tooltips
-            # - header.autohide
-            # - navigation.expand
             - navigation.footer
             - navigation.indexes
             - navigation.instant
-            # - navigation.prune
+            - navigation.prune
+            - navigation.path
             - navigation.sections
             - navigation.tabs
             - navigation.tabs.sticky
@@ -46,7 +44,6 @@ extra_css:
       - stylesheets/adr.css
 
 plugins:
-      # - blog
       - search
       - swagger-ui-tag
       - mkdocs-material-adr/adr
@@ -55,6 +52,7 @@ plugins:
 markdown_extensions:
       - admonition
       - attr_list
+      - md_in_html
       - def_list
       - pymdownx.tasklist:
               custom_checkbox: true
@@ -83,16 +81,16 @@ edit_uri: "edit/main/docs"
 nav:
       - Welcome: index.md
       - Overview:
-              - Components: genestack-components.md
               - Architecture: genestack-architecture.md
+              - Components: genestack-components.md
       - Quickstart:
               - Building Virtual Environments: build-test-envs.md
               - Simple Setup: quickstart.md
       - Deployment Guide:
-              - Getting Started: genestack-getting-started.md
+              - genestack-getting-started.md
               - Building the Cloud:
                       - Kubernetes:
-                              - K8s Overview: k8s-overview.md
+                              - k8s-overview.md
                               - Providers:
                                       - Kubespray: k8s-kubespray.md
                               - Post Deployment:
@@ -101,49 +99,43 @@ nav:
                                       - Kubernetes Taint: k8s-taint.md
                               - Retrieve kube config: k8s-config.md
                       - Storage:
-                              - Storage Overview: storage-overview.md
+                              - storage-overview.md
                               - Ceph Internal: storage-ceph-rook-internal.md
                               - Ceph External: storage-ceph-rook-external.md
                               - NFS External: storage-nfs-external.md
                               - TopoLVM: storage-topolvm.md
                       - Monitoring:
                               - Monitoring Overview: prometheus.md
                       - Secrets:
-                              - Vault Overview: vault.md
+                              - vault.md
                               - Vault Operator: vault-secrets-operator.md
                       - Infrastructure:
-                              - Infrastructure Overview: infrastructure-overview.md
+                              - infrastructure-overview.md
                               - Namespace: infrastructure-namespace.md
                               - Ingress: infrastructure-ingress.md
                               - MariaDB:
-                                      - MariaDB Deployment: infrastructure-mariadb.md
+                                      - infrastructure-mariadb.md
                                       - MySQL Exporter: prometheus-mysql-exporter.md
                               - PostgreSQL: infrastructure-postgresql.md
                               - RabbitMQ:
-                                      - RabbitMQ Deployment: infrastructure-rabbitmq.md
+                                      - infrastructure-rabbitmq.md
                                       - RabbitMQ Exporter: prometheus-rabbitmq-exporter.md
                               - Memcached: infrastructure-memcached.md
                               - Libvirt: infrastructure-libvirt.md
                               - OVN:
-                                      - OVN Overview: infrastructure-ovn.md
+                                      - infrastructure-ovn.md
                                       - OVN Setup: infrastructure-ovn-setup.md
                               - MetalLB: infrastructure-metallb.md
                       - OpenStack:
-                              - OpenStack Overview: openstack-overview.md
+                              - openstack-overview.md
                               - OpenStack Preparations: openstack-helm-make.md
                               - OpenStack Services:
-                                      - Keystone:
-                                              - Keystone Deployment: openstack-keystone.md
-                                              - Federation: openstack-keystone-federation.md
-                                      - Glance:
-                                              - Glance Deployment: openstack-glance.md
-                                              - Images: openstack-glance-images.md
+                                      - Keystone: openstack-keystone.md
+                                      - Glance: openstack-glance.md
                                       - Heat: openstack-heat.md
                                       - Cinder: openstack-cinder.md
-                                      - Compute Kit:
-                                              - Compute Kit Deployment: openstack-compute-kit.md
-                                              - Flavors: openstack-flavors.md
-                                      - Dashboard:
+                                      - Compute Kit: openstack-compute-kit.md
+                                      - Dashboards:
                                               - Horizon: openstack-horizon.md
                                               - skyline: openstack-skyline.md
                                       - Octavia: openstack-octavia.md
@@ -157,7 +149,10 @@ nav:
                       - Connecting to MySQL: infrastructure-mariadb-connect.md
               - OpenStack:
                       - Generating Clouds YAML: openstack-clouds.md
+                      - Keystone Federation to Rackspace: openstack-keystone-federation.md
+                      - Nova Flavor Creation: openstack-flavors.md
                       - Creating Networks: openstack-neutron-networks.md
+                      - Glance Images Creation: openstack-glance-images.md
               - Building Local Images: build-local-images.md
               - Third Party Tools:
                       - OSIE: extra-osie.md