Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Review page titles and filenames #238

Merged
merged 2 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Cluster Network Configurations in MicroCeph
===========================================
==============================
Cluster network configurations
==============================

Overview
--------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Scaling
=================
===============
Cluster scaling
===============


Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Full Disk Encryption on OSDs
============================
====================
Full disk encryption
====================


Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/explanation/snap-content-interface.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
MicroCeph Content Interface
===========================
====================================
Snap content interface for MicroCeph
====================================

Overview
--------
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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>`

7 changes: 4 additions & 3 deletions docs/how-to/alerts.rst → docs/how-to/enable-alerts.rst
Original file line number Diff line number Diff line change
@@ -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
------------
Expand Down
5 changes: 3 additions & 2 deletions docs/how-to/metrics.rst → docs/how-to/enable-metrics.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Enable MicroCeph metrics collection with Prometheus
===================================================
===========================================
Enabling metrics collection with Prometheus
===========================================

Introduction
------------
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==========================================
Migrate automatically-provisioned services
==========================================
============================================
Migrating automatically-provisioned services
============================================

MicroCeph deploys automatically-provisioned Ceph services when needed. These
services include:
Expand Down
8 changes: 4 additions & 4 deletions docs/how-to/remove-disk.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=============
Remove a disk
=============
===============
Removing a disk
===============

Overview
--------
Expand All @@ -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::
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/multi-node.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
11 changes: 5 additions & 6 deletions docs/tutorial/single-node.rst
Original file line number Diff line number Diff line change
@@ -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".
Expand All @@ -13,9 +13,8 @@ three entire disks are required to be available on the machine.

.. note::

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
Expand Down
Loading