docs(cleanup): Cleans up and updates landing page and deploy guide

Author: nicholaskuechler

docs/deploy-guide/gitops-install.md

@@ -29,7 +29,7 @@ git init uc-deploy
 git clone https://path/to/my/uc-deploy
 ```
 
-See [Deployment Repository](./getting-started.md#creation-and-access)
+See [Deployment Repository](./requirements.md#creation-and-access)
 
 ## Pre-deployment
 

docs/deploy-guide/getting-started.md renamed to docs/deploy-guide/requirements.md

@@ -1,11 +1,17 @@
-# Getting Started
+# Requirements
 
 To get started, ensure you have the following prerequisites:
 
+* A name for the deployment. For example `my-k3s`. We will refer to this
+  as `DEPLOY_NAME`.
 * A clone of this repository.
 * Another [Git repository,](#deploy-repository) referred to as the
   [Deploy Repository](#deploy-repository).
 * Access to at least one Kubernetes cluster.
+* A DNS zone. For example `dev.yourdomain.com`. We will refer to this
+  as `DNS_ZONE`.
+* Bare metal machines to adopt in OpenStack Ironic
+* Switches compatible with OpenStack Neutron
 
 For simplicity, you can use an All-In-One deployment. However, for
 production or large-scale deployments, it is recommended to use multiple

docs/index.md

@@ -9,23 +9,35 @@ hide:
 <!-- markdownlint-capture -->
 <!-- markdownlint-disable MD030 MD032 MD033 MD046 -->
 <div class="grid cards" markdown>
--   :material-cloud:{ .lg} __What is UnderStack?__
+-   :material-cloud:{ .lg .middle} __What is UnderStack?__
 
-    UnderStack is an opinionated deployment of OpenStack focused on bare metal
-    provisioning through Ironic and its related services. This allows for efficiently
-    and consistently managed hardware deployed via API-driven workflows across multiple
-    data centers at scale.
+    [UnderStack](https://github.com/rackerlabs/understack) is an opinionated deployment
+    of [OpenStack](https://www.openstack.org/) focused on bare metal provisioning
+    through [Ironic](https://docs.openstack.org/ironic/latest/) and its related services.
+    This allows for efficiently and consistently managed hardware deployed via API-driven
+    workflows across multiple data centers at scale.
 
     Core requirements include a pool of bare metal systems which can be controlled by
-    Ironic as well as switches that can be programmed by a Neutron ML2 driver and
-    infrastructure nodes which can host a Kubernetes cluster for the necessary services.
+    Ironic as well as switches that can be programmed by a
+    [Neutron ML2 driver](https://docs.openstack.org/neutron/latest/admin/config-ml2.html)
+    and infrastructure nodes which can host a _Kubernetes_ cluster for the necessary
+    services. In our development environment we use Dell servers and Cisco Nexus switches.
+
+-   :material-lightbulb:{ .lg .middle } __Features__
+
+    - OpenStack: Compute, Bare Metal, Network, Load Balancer, Block Storage, Object Storage
+    - ArgoCD deployments
+    - Nautobot DCIM/IPAM
+    - Dex authentication
+    - OVN networking
+    - Prometheus monitoring and metrics stack
+
+-   :material-abacus:{ .lg .middle } __Getting Started__
 
     The documentation covers both Kubernetes cluster deployment options and configuration
     of the UnderStack components for bare metal resource management in a multi-data center
     environment.
 
--   :material-abacus:{ .xl .middle } __Getting Started__
-
-    See our [Deploy Guide](deploy-guide/welcome.md) to begin with your own deployment.
+    See our [Deploy Guide](deploy-guide/welcome.md) to begin your own deployment.
 </div>
 <!-- markdownlint-restore -->

mkdocs.yml

@@ -122,7 +122,7 @@ nav:
     - design-guide/neutron-networking.md
   - 'Deployment Guide':
     - deploy-guide/welcome.md
-    - deploy-guide/getting-started.md
+    - deploy-guide/requirements.md
     - Quick Start: deploy-guide/gitops-install.md
     - Preparing Our Deployment:
       - deploy-guide/deploy-repo.md