From 58715e235416e7af12c347f47be720c715e29cf0 Mon Sep 17 00:00:00 2001
From: Jiri Konecny <jkonecny@redhat.com>
Date: Fri, 20 Dec 2024 13:05:29 +0100
Subject: [PATCH] Move docs advanced topics into new subsection

Currently everything is in one level when you open the Anaconda
documentation. There is a lot of topics. Let's make the documentation
a bit more structured.

Adding developer directory but also a page with this content so it is
more hidden.
---
 docs/developer.rst                           | 20 ++++++++++++++++++++
 docs/{ => developer}/commit-log.rst          |  0
 docs/{ => developer}/configuration-files.rst |  0
 docs/{ => developer}/driverdisc.rst          |  0
 docs/{ => developer}/drop-in-scripts.rst     |  0
 docs/{ => developer}/iscsi.rst               |  0
 docs/{ => developer}/mount-points.rst        |  0
 docs/{ => developer}/multipath.rst           |  0
 docs/{ => developer}/sysconfig-file.rst      |  0
 docs/{ => developer}/testing.rst             |  4 ++--
 docs/index.rst                               | 10 +---------
 11 files changed, 23 insertions(+), 11 deletions(-)
 create mode 100644 docs/developer.rst
 rename docs/{ => developer}/commit-log.rst (100%)
 rename docs/{ => developer}/configuration-files.rst (100%)
 rename docs/{ => developer}/driverdisc.rst (100%)
 rename docs/{ => developer}/drop-in-scripts.rst (100%)
 rename docs/{ => developer}/iscsi.rst (100%)
 rename docs/{ => developer}/mount-points.rst (100%)
 rename docs/{ => developer}/multipath.rst (100%)
 rename docs/{ => developer}/sysconfig-file.rst (100%)
 rename docs/{ => developer}/testing.rst (97%)

diff --git a/docs/developer.rst b/docs/developer.rst
new file mode 100644
index 00000000000..cd7173b0756
--- /dev/null
+++ b/docs/developer.rst
@@ -0,0 +1,20 @@
+Developer documentation
+=======================
+
+Here are topics which are covering mostly advanced topics to help users to modify Anaconda and understand the code.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   developer/commit-log
+   developer/configuration-files
+   developer/driverdisc
+   developer/iscsi
+   developer/mount-points
+   developer/multipath
+   developer/sysconfig-file
+   developer/drop-in-scripts
+   Testing <developer/testing>
+
diff --git a/docs/commit-log.rst b/docs/developer/commit-log.rst
similarity index 100%
rename from docs/commit-log.rst
rename to docs/developer/commit-log.rst
diff --git a/docs/configuration-files.rst b/docs/developer/configuration-files.rst
similarity index 100%
rename from docs/configuration-files.rst
rename to docs/developer/configuration-files.rst
diff --git a/docs/driverdisc.rst b/docs/developer/driverdisc.rst
similarity index 100%
rename from docs/driverdisc.rst
rename to docs/developer/driverdisc.rst
diff --git a/docs/drop-in-scripts.rst b/docs/developer/drop-in-scripts.rst
similarity index 100%
rename from docs/drop-in-scripts.rst
rename to docs/developer/drop-in-scripts.rst
diff --git a/docs/iscsi.rst b/docs/developer/iscsi.rst
similarity index 100%
rename from docs/iscsi.rst
rename to docs/developer/iscsi.rst
diff --git a/docs/mount-points.rst b/docs/developer/mount-points.rst
similarity index 100%
rename from docs/mount-points.rst
rename to docs/developer/mount-points.rst
diff --git a/docs/multipath.rst b/docs/developer/multipath.rst
similarity index 100%
rename from docs/multipath.rst
rename to docs/developer/multipath.rst
diff --git a/docs/sysconfig-file.rst b/docs/developer/sysconfig-file.rst
similarity index 100%
rename from docs/sysconfig-file.rst
rename to docs/developer/sysconfig-file.rst
diff --git a/docs/testing.rst b/docs/developer/testing.rst
similarity index 97%
rename from docs/testing.rst
rename to docs/developer/testing.rst
index 9e92fce8586..76535f54e60 100644
--- a/docs/testing.rst
+++ b/docs/developer/testing.rst
@@ -1,5 +1,5 @@
 
-.. include:: ../tests/README.rst
+.. include:: ../../tests/README.rst
 
 What to do if there are broken Rawhide dependencies
 ===================================================
@@ -38,7 +38,7 @@ Cleanup old repository.
     $ ssh <fedora_username>:fedorapeople.org
     $ cd /project/anaconda/repos/anaconda_fixup_repo/
     $ rm -rv *  # to remove the old directory structure
-    
+
 
 Create your repository locally and upload that.
 ::
diff --git a/docs/index.rst b/docs/index.rst
index 7df4cd0e01c..05f620fd3e0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,18 +15,10 @@ Contents:
    release-notes
    boot-options
    kickstart
-   configuration-files
    How to report a bug <reporting>
    common-bugs
    How to contribute <contributing>
-   commit-log
    release
-   driverdisc
-   iscsi
-   multipath
    list-harddrives
-   drop-in-scripts
-   sysconfig-file
-   mount-points
-   Testing <testing>
+   developer
    ci-status