From c29c1e7bb2da197e47c131223a59ba6229163f7b Mon Sep 17 00:00:00 2001 From: Matan Breizman Date: Sun, 27 Oct 2024 16:32:58 +0000 Subject: [PATCH] doc/dev/crimson: update index Signed-off-by: Matan Breizman --- doc/dev/crimson/backfillmachine.rst | 8 +++++--- doc/dev/crimson/index.rst | 10 +++++++--- doc/dev/crimson/osd.rst | 4 ++-- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/doc/dev/crimson/backfillmachine.rst b/doc/dev/crimson/backfillmachine.rst index c42bb32bbfa..3f579621ad4 100644 --- a/doc/dev/crimson/backfillmachine.rst +++ b/doc/dev/crimson/backfillmachine.rst @@ -3,7 +3,7 @@ BackfillMachine =============== -In Crimson, Backfill is implemented with `Boost State Chart `_. +In Crimson, backfill is implemented with `Boost State Chart `_. .. //TODO: Once the implementation is settled: .. * Explain exceptional states once we finish working on this code @@ -14,8 +14,10 @@ A sample of the recent state model: .. note:: ``Cancelled`` and ``Crushed`` states are not included in the following graph in order to make it easier to follow: - * **Any** state is able to transit into ``Crushed``. - * **Any** state (except from ``Initial`` and ``Waiting``) can transit into ``Cancelled`` + + * **Any** state is able to transit into ``Crushed``. + + * **Any** state (except from ``Initial`` and ``Waiting``) can transit into ``Cancelled`` .. image:: crimson_backfillmachine.svg diff --git a/doc/dev/crimson/index.rst b/doc/dev/crimson/index.rst index 9790a9640c2..53864350bd7 100644 --- a/doc/dev/crimson/index.rst +++ b/doc/dev/crimson/index.rst @@ -7,7 +7,11 @@ Crimson developer documentation .. rubric:: Contents .. toctree:: - :glob: - - * + :maxdepth: 1 + Crimson + OSDState + The ClientRequest Pipeline + Error Handling + BackfillMachine + PoseidonStore diff --git a/doc/dev/crimson/osd.rst b/doc/dev/crimson/osd.rst index f7f132b3f9d..4e78f648f45 100644 --- a/doc/dev/crimson/osd.rst +++ b/doc/dev/crimson/osd.rst @@ -1,5 +1,5 @@ -osd -=== +OSDState +======== .. graphviz:: -- 2.47.3