From 1aab26e01c4656e661e62b487ecca2f3e6f2e8c7 Mon Sep 17 00:00:00 2001 From: Elijah Greenstein Date: Tue, 21 Apr 2026 14:15:45 -0700 Subject: [PATCH 1/2] doc: update how-to, ref landing pages This commit updates the landing pages for the how-to guides and reference materials: - Summaries have been edited for brevity - Some summaries have been removed due to redundancy with the TOC titles - The reference materials have been reorganized to foreground the CLI - The how-to guide headers have been edited to consistently begin with action verbs Signed-off-by: Elijah Greenstein (cherry picked from commit 2bf847e216822b350107e557d1c035b53afdc6d9) Removed Cluster Manager information, since it is not a v2 feature. --- doc/how-to/index.md | 39 ++++++++++++++++++--------------------- doc/reference/index.md | 19 ++++++++----------- 2 files changed, 26 insertions(+), 32 deletions(-) diff --git a/doc/how-to/index.md b/doc/how-to/index.md index 441a469dc..f00929dd4 100644 --- a/doc/how-to/index.md +++ b/doc/how-to/index.md @@ -9,11 +9,12 @@ myst: These MicroCloud how-to guides cover key operations and processes. -## Initial setup +## Set up and deploy -Follow these guides to install MicroCloud in a testing or production environment -and initialize MicroCloud through interactive or automated configuration -processes. You can also set up access to the MicroCloud UI. +MicroCloud can be installed in testing or production environments and +initialized interactively or through an automated process. Once deployed, the +MicroCloud UI provides an interface alongside the {ref}`MicroCloud CLI +`. ```{toctree} :maxdepth: 1 @@ -23,10 +24,19 @@ Initialize MicroCloud Access the UI ``` +Terraform makes it possible to automate the MicroCloud deployment process. + +```{toctree} +:maxdepth: 1 + +Deploy a MicroCloud test environment with Terraform +``` + ## Configure services -You can configure storage with MicroCeph and networking with MicroOVN during the -initialization process, or you can add a service later. +MicroCeph and MicroOVN make it possible to configure storage and networking to +meet your needs. Configure these services during a MicroCloud initialization, or +add a service later. ```{toctree} :maxdepth: 1 @@ -38,8 +48,8 @@ Add a service ## Manage clusters and cluster members -As your needs change, follow these steps to manage your clusters and cluster -members and keep your deployment up to date. +As your needs change, manage clusters and cluster members to keep your +deployment up to date. ```{toctree} :maxdepth: 1 @@ -50,21 +60,8 @@ Update and upgrade Manage the snaps ``` -## Automated deployment with Terraform - -Follow this guide to automate the deployment of MicroCloud with Terraform. - -```{toctree} -:maxdepth: 1 - -Deploy a MicroCloud test environment with Terraform -``` - ## Engage with us -Find out how to get community and commercial support, and learn how to -contribute to the MicroCloud project. - ```{toctree} :maxdepth: 1 diff --git a/doc/reference/index.md b/doc/reference/index.md index c6bda04a3..4a54c277b 100644 --- a/doc/reference/index.md +++ b/doc/reference/index.md @@ -3,25 +3,22 @@ This section provides technical reference guides for MicroCloud. -## Requirements and releases +## Commands -Find out about requirements for a MicroCloud deployment, as well as information -about its release cycles, release types, and snaps. +Consult this command reference to work with MicroCloud through the CLI. ```{toctree} :maxdepth: 1 -MicroCloud requirements -/reference/releases-snaps -/reference/release-notes/index +/reference/commands ``` -## Commands - -Use this command reference to perform common MicroCloud operations through the -CLI. +## Requirements and releases ```{toctree} :maxdepth: 1 -/reference/commands + +MicroCloud requirements +/reference/releases-snaps +/reference/release-notes/index ``` From 6392087c3b71346031d44d928dc4706842097408 Mon Sep 17 00:00:00 2001 From: Elijah Greenstein Date: Tue, 21 Apr 2026 16:53:06 -0700 Subject: [PATCH 2/2] doc: edit html metadata on index pages This commit edits the HTML metadata to clarify that the tutorial, how-to guide, explanation, and reference landing pages are index pages, not the actual content. Signed-off-by: Elijah Greenstein (cherry picked from commit a5259b965143d1c324e60bad4549919364294e48) Removed Cluster Manager information, since it is not a v2 feature --- doc/explanation/index.md | 2 +- doc/how-to/index.md | 2 +- doc/reference/index.md | 6 ++++++ doc/tutorial/index.md | 2 +- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/explanation/index.md b/doc/explanation/index.md index 9e3375913..ee956fc6b 100644 --- a/doc/explanation/index.md +++ b/doc/explanation/index.md @@ -1,7 +1,7 @@ --- myst: html_meta: - description: Deep-dive explanations that introduce you to concepts in MicroCloud, such as its networking approach and local versus distributed storage. + description: An index of explanations about MicroCloud concepts, such as its relationship to LXD, Ceph, and OVN and its approach to networking, storage, and security. --- (explanation)= diff --git a/doc/how-to/index.md b/doc/how-to/index.md index f00929dd4..e4b4c9589 100644 --- a/doc/how-to/index.md +++ b/doc/how-to/index.md @@ -1,7 +1,7 @@ --- myst: html_meta: - description: How-to guides for key MicroCloud operations, including installation, initialization, UI access, configuration, cluster management, updates, and more. + description: An index of how-to guides for key MicroCloud operations, including installation, initialization, UI access, configuration, management, and updates. --- (howto)= diff --git a/doc/reference/index.md b/doc/reference/index.md index 4a54c277b..cff299af6 100644 --- a/doc/reference/index.md +++ b/doc/reference/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: An index of MicroCloud reference guides covering CLI commands, deployment requirements, releases, and snap details. +--- + (reference)= # Reference diff --git a/doc/tutorial/index.md b/doc/tutorial/index.md index e29747e2e..3de926983 100644 --- a/doc/tutorial/index.md +++ b/doc/tutorial/index.md @@ -1,7 +1,7 @@ --- myst: html_meta: - description: Hands-on tutorials to install, initialize, and try out test deployments of MicroCloud, on a single physical machine or multiple virtual machines. + description: An index to hands-on tutorials to install, initialize, and try out test deployments of MicroCloud, on a single physical machine or multiple virtual machines. --- (get-started)=