From 110876557e095949da1295ca5c7eca551a808856 Mon Sep 17 00:00:00 2001
From: Peter Matulis <peter.matulis@canonical.com>
Date: Fri, 13 Oct 2023 19:50:25 -0400
Subject: [PATCH 1/2] Review page titles and filenames

Signed-off-by: Peter Matulis <peter.matulis@canonical.com>
---
 .../{cluster-cfg.rst => cluster-configurations.rst}       | 5 +++--
 docs/explanation/{scaling.rst => cluster-scaling.rst}     | 5 +++--
 .../explanation/{fde-osd.rst => full-disk-encryption.rst} | 5 +++--
 docs/explanation/snap-content-interface.rst               | 5 +++--
 .../{cluster-cfg.rst => configure-network-keys.rst}       | 7 ++++---
 docs/how-to/{alerts.rst => enable-alerts.rst}             | 7 ++++---
 docs/how-to/{metrics.rst => enable-metrics.rst}           | 5 +++--
 ...service-placement.rst => enable-service-instances.rst} | 6 +++---
 .../{service-migration.rst => migrate-auto-services.rst}  | 6 +++---
 docs/how-to/remove-disk.rst                               | 8 ++++----
 docs/tutorial/multi-node.rst                              | 6 +++---
 docs/tutorial/single-node.rst                             | 8 ++++----
 12 files changed, 40 insertions(+), 33 deletions(-)
 rename docs/explanation/{cluster-cfg.rst => cluster-configurations.rst} (94%)
 rename docs/explanation/{scaling.rst => cluster-scaling.rst} (99%)
 rename docs/explanation/{fde-osd.rst => full-disk-encryption.rst} (97%)
 rename docs/how-to/{cluster-cfg.rst => configure-network-keys.rst} (92%)
 rename docs/how-to/{alerts.rst => enable-alerts.rst} (89%)
 rename docs/how-to/{metrics.rst => enable-metrics.rst} (96%)
 rename docs/how-to/{service-placement.rst => enable-service-instances.rst} (95%)
 rename docs/how-to/{service-migration.rst => migrate-auto-services.rst} (91%)

diff --git a/docs/explanation/cluster-cfg.rst b/docs/explanation/cluster-configurations.rst
similarity index 94%
rename from docs/explanation/cluster-cfg.rst
rename to docs/explanation/cluster-configurations.rst
index 4e9f6055..f51675ad 100644
--- a/docs/explanation/cluster-cfg.rst
+++ b/docs/explanation/cluster-configurations.rst
@@ -1,5 +1,6 @@
-Cluster Network Configurations in MicroCeph
-===========================================
+==============================
+Cluster network configurations
+==============================
 
 Overview
 --------
diff --git a/docs/explanation/scaling.rst b/docs/explanation/cluster-scaling.rst
similarity index 99%
rename from docs/explanation/scaling.rst
rename to docs/explanation/cluster-scaling.rst
index ca989f5f..fba4100c 100644
--- a/docs/explanation/scaling.rst
+++ b/docs/explanation/cluster-scaling.rst
@@ -1,5 +1,6 @@
-Scaling
-=================
+===============
+Cluster scaling
+===============
 
 
 Overview
diff --git a/docs/explanation/fde-osd.rst b/docs/explanation/full-disk-encryption.rst
similarity index 97%
rename from docs/explanation/fde-osd.rst
rename to docs/explanation/full-disk-encryption.rst
index 4bbdccc0..cb8d3540 100644
--- a/docs/explanation/fde-osd.rst
+++ b/docs/explanation/full-disk-encryption.rst
@@ -1,5 +1,6 @@
-Full Disk Encryption on OSDs
-============================
+====================
+Full disk encryption
+====================
 
 
 Overview
diff --git a/docs/explanation/snap-content-interface.rst b/docs/explanation/snap-content-interface.rst
index abdf315e..f24b6c10 100644
--- a/docs/explanation/snap-content-interface.rst
+++ b/docs/explanation/snap-content-interface.rst
@@ -1,5 +1,6 @@
-MicroCeph Content Interface
-===========================
+====================================
+Snap content interface for MicroCeph
+====================================
 
 Overview
 --------
diff --git a/docs/how-to/cluster-cfg.rst b/docs/how-to/configure-network-keys.rst
similarity index 92%
rename from docs/how-to/cluster-cfg.rst
rename to docs/how-to/configure-network-keys.rst
index 858a94ca..e36f8420 100644
--- a/docs/how-to/cluster-cfg.rst
+++ b/docs/how-to/configure-network-keys.rst
@@ -1,5 +1,6 @@
-Configure cluster_network/ public_network in MicroCeph
-======================================================
+========================
+Configuring network keys
+========================
 
 The MicroCeph cluster configuration CLI supports setting, getting, resetting and listing supported config keys mentioned below.
 
@@ -56,5 +57,5 @@ The MicroCeph cluster configuration CLI supports setting, getting, resetting and
    | # | KEY | VALUE |
    +---+-----+-------+
 
-For more explanations and implementation details refer to :doc:`explanation <../explanation/cluster-cfg>`
+For more explanations and implementation details refer to :doc:`explanation <../explanation/cluster-configurations>`
 
diff --git a/docs/how-to/alerts.rst b/docs/how-to/enable-alerts.rst
similarity index 89%
rename from docs/how-to/alerts.rst
rename to docs/how-to/enable-alerts.rst
index ece665af..d80451fa 100644
--- a/docs/how-to/alerts.rst
+++ b/docs/how-to/enable-alerts.rst
@@ -1,9 +1,10 @@
-Enable alerts on MicroCeph using Prometheus Alertmanager
-========================================================
+=======================================
+Enabling Prometheus Alertmanager alerts
+=======================================
 
 Pre-Requisite
 -------------
-In order to configure alerts, your MicroCeph deployment must enable metrics collections with Prometheus. Follow :doc:`this How-To <metrics>` if you haven't configured it. Also, Alertmanager is distributed as a separate binary which should be installed and running.
+In order to configure alerts, your MicroCeph deployment must enable metrics collections with Prometheus. Follow :doc:`this How-To <enable-metrics>` if you haven't configured it. Also, Alertmanager is distributed as a separate binary which should be installed and running.
 
 Introduction
 ------------
diff --git a/docs/how-to/metrics.rst b/docs/how-to/enable-metrics.rst
similarity index 96%
rename from docs/how-to/metrics.rst
rename to docs/how-to/enable-metrics.rst
index 87cb8fcc..4b172afc 100644
--- a/docs/how-to/metrics.rst
+++ b/docs/how-to/enable-metrics.rst
@@ -1,5 +1,6 @@
-Enable MicroCeph metrics collection with Prometheus
-===================================================
+===========================================
+Enabling metrics collection with Prometheus
+===========================================
 
 Introduction
 ------------
diff --git a/docs/how-to/service-placement.rst b/docs/how-to/enable-service-instances.rst
similarity index 95%
rename from docs/how-to/service-placement.rst
rename to docs/how-to/enable-service-instances.rst
index 521857eb..27bc1c88 100644
--- a/docs/how-to/service-placement.rst
+++ b/docs/how-to/enable-service-instances.rst
@@ -1,6 +1,6 @@
-===================================
-Enable additional service instances
-===================================
+=====================================
+Enabling additional service instances
+=====================================
 
 To ensure a base level of resiliency, MicroCeph will always try to enable a
 sufficient number of instances for certain services in the cluster. This
diff --git a/docs/how-to/service-migration.rst b/docs/how-to/migrate-auto-services.rst
similarity index 91%
rename from docs/how-to/service-migration.rst
rename to docs/how-to/migrate-auto-services.rst
index abd5adaa..09ddfc9f 100644
--- a/docs/how-to/service-migration.rst
+++ b/docs/how-to/migrate-auto-services.rst
@@ -1,6 +1,6 @@
-==========================================
-Migrate automatically-provisioned services
-==========================================
+============================================
+Migrating automatically-provisioned services
+============================================
 
 MicroCeph deploys automatically-provisioned Ceph services when needed. These
 services include:
diff --git a/docs/how-to/remove-disk.rst b/docs/how-to/remove-disk.rst
index 9c07158b..907860fd 100644
--- a/docs/how-to/remove-disk.rst
+++ b/docs/how-to/remove-disk.rst
@@ -1,6 +1,6 @@
-=============
-Remove a disk
-=============
+===============
+Removing a disk
+===============
 
 Overview
 --------
@@ -12,7 +12,7 @@ the removal of a cluster node (machine).
 
 The following resources provide extra context to the disk removal operation:
 
-* the :doc:`../../explanation/scaling` page
+* the :doc:`../../explanation/cluster-scaling` page
 * the :doc:`disk <../reference/commands/disk>` command reference
 
 .. note::
diff --git a/docs/tutorial/multi-node.rst b/docs/tutorial/multi-node.rst
index 0904c84c..f1dfc15b 100644
--- a/docs/tutorial/multi-node.rst
+++ b/docs/tutorial/multi-node.rst
@@ -1,6 +1,6 @@
-==========
-Multi-node
-==========
+==================
+Multi-node install
+==================
 
 This tutorial will show how to install MicroCeph on three machines, thereby
 creating a multi-node cluster.
diff --git a/docs/tutorial/single-node.rst b/docs/tutorial/single-node.rst
index 5b405b19..18293c23 100644
--- a/docs/tutorial/single-node.rst
+++ b/docs/tutorial/single-node.rst
@@ -1,6 +1,6 @@
-===========
-Single-node
-===========
+===================
+Single-node install
+===================
 
 This tutorial will show how to install MicroCeph on a single machine, thereby
 creating a single-node "cluster".
@@ -13,7 +13,7 @@ three entire disks are required to be available on the machine.
 
 .. note::
 
-   Development is underway to allow for loopback device support.
+   Upstream Ceph development is underway to allow for loopback device support.
    This will filter down to MicroCeph which will allow for easier
    proof-of-concept and developer deployments.
 

From aa5447cc83813d153df547b3ea2e5d98956b7eb0 Mon Sep 17 00:00:00 2001
From: Peter Matulis <peter.matulis@canonical.com>
Date: Mon, 16 Oct 2023 19:37:41 -0400
Subject: [PATCH 2/2] Edited as per review

Signed-off-by: Peter Matulis <peter.matulis@canonical.com>
---
 docs/tutorial/single-node.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/docs/tutorial/single-node.rst b/docs/tutorial/single-node.rst
index 18293c23..fc58f329 100644
--- a/docs/tutorial/single-node.rst
+++ b/docs/tutorial/single-node.rst
@@ -13,9 +13,8 @@ three entire disks are required to be available on the machine.
 
 .. note::
 
-   Upstream Ceph development is underway to allow for loopback device support.
-   This will filter down to MicroCeph which will allow for easier
-   proof-of-concept and developer deployments.
+   Development is underway to allow for loopback device support. This will
+   allow for easier proof-of-concept and developer deployments.
 
 The disk subsystem can be inspected with the :command:`lsblk` command. In this
 tutorial, the command's output is shown below. Any output related to possible