From: Bill Scales <bill_scales@uk.ibm.com>
Date: Tue, 19 May 2026 06:05:13 +0000 (+0100)
Subject: doc/dev/internals: Improve Ceph Internals TOC
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=91090ee16a3aaa76a53af1b1f137d7f1eb028312;p=ceph.git

doc/dev/internals: Improve Ceph Internals TOC

The Ceph internals section of the docs is a bit of a mess
as far as the table of contents is concerned. This commit
tries to add a bit more structure grouping topics by
area and trying to arrange them in a more logical order.

Signed-off-by: Bill Scales <bill_scales@uk.ibm.com>
---

diff --git a/doc/dev/internals.rst b/doc/dev/internals.rst
index 5d5dbd2caae4..a2956dd2dd0f 100644
--- a/doc/dev/internals.rst
+++ b/doc/dev/internals.rst
@@ -5,18 +5,17 @@
 .. note:: For information on how to use Ceph as a library (from your own
    software), see :doc:`/api/index`.
 
-Starting a Development-mode Ceph Cluster
-----------------------------------------
+This section contains documentation about the internal architecture and
+implementation details of Ceph components. It is organized by major subsystem
+to help developers navigate the codebase.
 
-Compile the source and then run the following commands to start a
-development-mode Ceph cluster::
+Getting Started with Development
+================================
 
-	cd build
-	OSD=3 MON=3 MGR=3 ../src/vstart.sh -n -x
-	# check that it's there
-	bin/ceph health
+.. note:: You may also be interested in the :doc:`/dev/developer_guide/index` documentation.
 
-.. rubric:: Mailing list
+Community Mailing Lists
+-----------------------
 
 The ``dev@ceph.io`` list is for discussion about the development of Ceph,
 its interoperability with other technology, and the operations of the
@@ -33,22 +32,190 @@ Subscribe by sending a message to ``majordomo@vger.kernel.org`` with the line::
 
 in the body of the message.
 
-.. raw:: html
+Starting a Development-mode Ceph Cluster
+----------------------------------------
+
+Compile the source and then run the following commands to start a
+development-mode Ceph cluster::
 
-   <!---
+	cd build
+	OSD=3 MON=3 MGR=3 ../src/vstart.sh -n -x
+	# check that it's there
+	bin/ceph health
 
-.. rubric:: Contents
+Development Processes
+---------------------
 
 .. toctree::
-   :glob:
+   :maxdepth: 1
+
+   quick_guide
+   dev_cluster_deployment
+   development-workflow
+   testing
+   sepia
+   continuous-integration
+   release-process
+   release-checklists
+
+Documentation Processes
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   documenting
+   generatedocs
+
+Core Architecture
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   logs
+   logging
+   health-reports
+   config
+   config-key
+   context
+   encoding
+   corpus
+   network-encoding
+   mempool_accounting
+   iana
+   cxx
+
+RADOS and Object Store
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   object-store
+   bluestore
+   balancer-design
+   deduplication
+   zoned-storage
+   crush-msr
+   blkin
+   libs
+   osd-class-path
+
+OSD
+---
+
+.. toctree::
+   :maxdepth: 2
+
+   osd_internals/index
+   peering
+   placement-group
+   erasure-coded-pool
+   pool-migration-design
+   versions
+   crimson/index
+
+Monitor
+-------
 
-   *
-   osd_internals/index*
-   mds_internals/index*
-   radosgw/index*
-   ceph-volume/index*
-   crimson/index*
+.. toctree::
+   :maxdepth: 1
+
+   mon-bootstrap
+   mon-elections
+   mon-on-disk-formats
+   mon-osdmap-prune
+
+CephFS and MDS
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   mds_internals/index
+   cephfs-snapshots
+   cephfs-mirroring
+   cephfs-reclaim
+   cephfs-fscrypt
+   file-striping
+   delayed-delete
+   kclient
+   vstart-ganesha
+   libcephfs_proxy
+
+RADOS Gateway (RGW)
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   radosgw/index
+
+RBD
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   rbd-diff
+   rbd-export
+   rbd-layering
+
+Messaging and Networking
+========================
+
+.. toctree::
+   :maxdepth: 1
+
+   messenger
+   msgr2
+   network-protocol
+   rados-client-protocol
+   dpdk
+   wireshark
+
+Authentication and Security
+===========================
+
+.. toctree::
+   :maxdepth: 1
+
+   cephx
+   cephx_protocol
+   session_authentication
+   ceph_krb_auth
+
+Management and Orchestration
+============================
+
+.. toctree::
+   :maxdepth: 2
+
+   cephadm/index
+   ceph-volume/index
+
+.. note:: See :doc:`/dev/developer_guide/dash-devel` for dashboard documentation.
+
+Performance
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   perf
+   perf_counters
+   perf_histograms
+   cpu-profiler
+   cputrace
+
+Platform-Specific
+=================
+
+.. toctree::
+   :maxdepth: 1
 
-.. raw:: html
+   freebsd
+   macos
+   kubernetes
 
-   --->