Minor refactor of folders, autogenerate folders of documentation #500

voetberg · rdimaio · commit acc1845f95bd · 2025-04-10T12:51:06.000+02:00
diff --git a/docs/developer/webui/_category_.json b/docs/developer/webui/_category_.json
@@ -0,0 +1,4 @@
+{
+    "label": "Web UI", 
+    "collapsible": true
+}
diff --git a/docs/index.md b/docs/index.md
@@ -25,9 +25,9 @@ system? Who uses it? What powers these systems? Answers to all these questions
 and more can be found by browsing through the sub-sections of this topic.
 
 - [What is Rucio](started/what_is_rucio.md)
-- [Main Components](started/main_components.md)
+- [Main Components](started/main_components/main_components.md)
 - [Additional Layers and Resources](started/additional_layers_and_resources.md)
-- [About Rucio Daemons](started/daemons.md)
+- [About Rucio Daemons](started/main_components/daemons.md)
 
 ## Client
 
diff --git a/docs/operator/configuration.md b/docs/operator/configuration.md
@@ -2,6 +2,7 @@
 id: configuration
 title: Configuration
 sidebar_label: Configuration
+sidebar_position: 5
 ---
 
 ## Prerequisites
diff --git a/docs/operator/configuration_parameters.md b/docs/operator/configuration_parameters.md
@@ -487,22 +487,22 @@ a setting already specified in the Configuration File.
 ## RSE settings
 The RSE settings are set separately using `rucio.RSEClient.update_rse` or `rucio rse update`, and specifies RSE configuration used by the Rucio instance.
 Mutable settings are `deterministic`, `rse_type`, `staging_area`, `volatile`, `qos_class`, `availability_delete`, `availability_read`, `availability_write`, `city`, `country_name`, `latitude`, `longitude`, `region_code`, and `time_zone`.
-Read more about RSEs [here](../started/concepts/rucio_storage_element.md)
-and how to set them up [here](./configuration.md#creating-new-rses).
+Read more about RSEs [here](started/concepts/rucio_storage_element.md)
+and how to set them up [here](operator/configuration.md#creating-new-rses).
 
 - **availability_delete**: Boolean. Control if this RSE allows deletions by the Reaper daemon using any protocol. Default: `True`.
 - **availability_read**: Boolean. Control if this RSE allows reads using any protocol. Default: `True`.
 - **availability_write**: Boolean. Control if this RSE allows writes using any protocol. Default: `True`.
 - **credentials**: Dictionary[String, Any]: Specify token credentials used for accessing this RSE if it is in a commercial cloud. No default.
 - **delete_protocol**: Integer: Cannot be changed. Controls matching of protocol priorities for deletions. Default: `1`.
-- **deterministic**: Boolean: Controls if the RSE is allowed to generate paths based solely on the DID (scope:filename). More info about non-deterministic RSEs [here](https://rucio.github.io/documentation/started/concepts/replica_workflow/#replica-paths-on-storage). Default: `True`.
+- **deterministic**: Boolean: Controls if the RSE is allowed to generate paths based solely on the DID (scope:filename). More info about non-deterministic RSEs [here](started/concepts/replica_workflow/#replica-paths-on-storage). Default: `True`.
 - **domain**: List[String]: Specifies the locations this RSE may be accessed by clients from. Cannot be changed.
 - **id**: String: Identification string of the RSE. Cannot be changed.
 - **lfn2pfn_algorithm**: String: Name of the algorithm in the configured policy package to be used for creating replica paths. Cannot be changed. If no lfn2pfn_algorithm attribute is set, then the setting defaults to lfn2pfn_algorithm_default in the configured policy package. Default: `default`.
 - **qos_class**: String: No functionality in modern Rucio. No default.
 - **read_protocol**: Integer: Cannot be changed. Controls matching of protocol priorities for reads. Default: `1`.
 - **rse**: String: The name of the Rucio Storage Element as given at creation time. Cannot be changed.
-- **rse_type**: String: Specify `DISK` or `TAPE` for control of [QoS](https://rucio.github.io/documentation/operator/qos_rse_config). Default: `DISK`.
+- **rse_type**: String: Specify `DISK` or `TAPE` for control of [QoS](operator/qos_rse_config). Default: `DISK`.
 - **sign_url**: Optional[str]. Enable cloud support for this storage element. No default.
 - **staging_area**: Boolean.Specify if this RSE is a disk buffer to a tertiary storage backend, subject to additional constraints (specifically a lifetime for rules on this RSE must be defined). Default: `False`.
 - **third_party_copy_read_protocol**: Integer: Cannot be changed. Controls matching of protocol priorities for TPC reads. Default `1`.
@@ -514,8 +514,8 @@ and how to set them up [here](./configuration.md#creating-new-rses).
 ## RSE attributes
 The RSE Attributes are set separately using `rucio.RSEClient.add_rse_attribute` or `rucio rse attribute add`.
 and only contains information about the specific RSE's for the Rucio instance.
-Read more about RSEs [here](../started/concepts/rucio_storage_element.md)
-and how to set them up [here](./configuration.md#creating-new-rses).
+Read more about RSEs [here](started/concepts/rucio_storage_element.md)
+and how to set them up [here](operator/configuration.md#creating-new-rses).
 
 - **associated_sites**: String. Separated by commas. Used for chaining of subscriptions so that transfers to one RSE will also be mirrored to associated_sites. No default.
 - **archive_timeout**: Integer: Only used for transfers with a tape destination. Controls the number of seconds the FTS3 transfer manager will wait for the tape archival of the file to go `FAILED` or `FINISHED`. No default.
@@ -532,7 +532,7 @@ and how to set them up [here](./configuration.md#creating-new-rses).
 - **greedyDeletion**: Boolean. Allow files without a rule locking them to be deleted by a Reaper Daemon. Default behavior only marks a file for deletion when there is no space on an RSE for a new required file. Default: `False`.
 - **group_by_rse_attribute**: String. Control the RSE attribute (such as `country`) which transfer source RSEs will be grouped by when determining an appropriate transfer source. Default: `UNKNOWN`.
 - **globus_endpoint_id**: String. Specify the REST API URL of the Globus transfer manager. No default.
-- **hop_penalty**: Integer. Usage cost of this RSE as an intermediate in [multihop transfers](https://rucio.github.io/documentation/operator/transfers/transfers-overview). Overrides the global `transfers/hop_penalty` configuration for this particular RSE.
+- **hop_penalty**: Integer. Usage cost of this RSE as an intermediate in [multihop transfers](transfers/transfers_overview.md). Overrides the global `transfers/hop_penalty` configuration for this particular RSE.
  Requires `available_for_multihop` attribute is True on the RSE. No default.
 - **is_object_store**: Boolean. Control the auditor daemon's behavior. Instead of dumping all files, list them by date. Default: `False`.
 - **istape**: Boolean. Default: `False`.
diff --git a/docs/operator/installing_daemons.md b/docs/operator/installing_daemons.md
@@ -1,6 +1,7 @@
 ---
 id: installing_daemons
 title: Installing Rucio Daemons
+sidebar_position: 4
 ---
 
 ## Prerequisites
diff --git a/docs/operator/installing_server.md b/docs/operator/installing_server.md
@@ -1,6 +1,7 @@
 ---
 id: installing_server
 title: Installing Rucio Server
+sidebar_position: 3
 ---
 
 ## Prerequisites
diff --git a/docs/operator/kubernetes.md b/docs/operator/kubernetes.md
@@ -1,6 +1,7 @@
 ---
 id: kubernetes
 title: Setting up Rucio on Kubernetes
+sidebar_position: 2
 ---
 
 ## Helm charts
diff --git a/docs/operator/setting_up_demo.md b/docs/operator/setting_up_demo.md
@@ -1,6 +1,7 @@
 ---
 id: setting_up_demo
 title: Setting up a Rucio demo environment
+sidebar_position: 1
 ---
 
 ## Prerequisites
diff --git a/docs/started/additional_layers_and_resources.md b/docs/started/additional_layers_and_resources.md
@@ -1,9 +1,10 @@
 ---
 id: additional_layers_and_resources
 title: Additional Layers and Resources
+sidebar_position: 4
 ---
 
-In addition to the four [main layers](started/main_components.md), we have the storage
+In addition to the four [main layers](started/main_components/main_components.md), we have the storage
 resources & transfer tools, as well as the underlying persistent layers. These
 are represented in the architecture diagram by the different *queuing systems*,
 *transactional* relational databases, & *analytics* storage on non-relational
diff --git a/docs/started/before_you_get_started.md b/docs/started/before_you_get_started.md
@@ -1,6 +1,7 @@
 ---
 id: before_you_get_started
 title: Before you get started
+sidebar_position: 1
 ---
 
 A great starting point for those absolutely new to Rucio, this section aims to
@@ -9,5 +10,5 @@ behind this project, what we are looking to achieve, & what we have done so far
 are some of the points covered in this section.
 
 - [What is Rucio?](what_is_rucio.md)
-- [Main Components](main_components.md)
+- [Main Components](main_components/main_components.md)
 - [Additional layers and Resources](additional_layers_and_resources.md)
diff --git a/docs/started/concepts/_category_.json b/docs/started/concepts/_category_.json
@@ -0,0 +1,5 @@
+{
+    "label": "Concepts", 
+    "collapsible": true, 
+    "position": 6
+}
diff --git a/docs/started/concepts/rucio_storage_element.md b/docs/started/concepts/rucio_storage_element.md
@@ -37,4 +37,4 @@ transfer requests can be made to Rucio in order to populate the cache.
 When configuring transfers between RSEs, distances must be defined for that link.
 Distances are unidirectional. To allow transfers in both directions, a distance
 has to be defined separately in each direction. Refer to the section
-[Transfers Overview](operator/transfers/transfers_overview.md) for more details.
+[Transfers Overview](transfers/transfers_overview.md) for more details.
diff --git a/docs/started/main_components/_category_.json b/docs/started/main_components/_category_.json
@@ -0,0 +1,6 @@
+{
+    "label": "Main Components", 
+    "collapsible": true, 
+    "link": {"type": "doc", "id":"started/main_components/main_components"}, 
+    "position": 3
+}
diff --git a/docs/started/main_components/daemons.md b/docs/started/main_components/daemons.md
diff --git a/docs/started/main_components/main_components.md b/docs/started/main_components/main_components.md
diff --git a/docs/started/releasepolicy.md b/docs/started/releasepolicy.md
@@ -2,6 +2,7 @@
 id: releasepolicy
 title: Release Policy
 sidebar_label: Release Policy
+sidebar_position: 8
 ---
 
 Rucio follows a release policy, based on [semantic versioning](https://semver.org),
diff --git a/docs/started/what_is_rucio.md b/docs/started/what_is_rucio.md
@@ -1,6 +1,7 @@
 ---
 id: what_is_rucio
 title: What is Rucio?
+sidebar_position: 2
 ---
 
 Rucio enables centralized management of large volumes of data backed by many
diff --git a/docs/transfers/_category_.json b/docs/transfers/_category_.json
@@ -0,0 +1,4 @@
+{
+    "label": "Transfers", 
+    "collapsible": true
+}
diff --git a/docs/transfers/configure_fts3_plugins.md b/docs/transfers/configure_fts3_plugins.md
diff --git a/docs/transfers/configure_globus_transfertool.md b/docs/transfers/configure_globus_transfertool.md
diff --git a/docs/transfers/transfers_overview.md b/docs/transfers/transfers_overview.md
diff --git a/docs/transfers/transfers_preparer.md b/docs/transfers/transfers_preparer.md
diff --git a/docs/transfers/transfers_submitter.md b/docs/transfers/transfers_submitter.md
diff --git a/docs/transfers/transfers_throttler.md b/docs/transfers/transfers_throttler.md
diff --git a/docs/user/configuring_the_client.md b/docs/user/configuring_the_client.md
@@ -1,5 +1,6 @@
 ---
 title: Configuring the Client
+sidebar_position: 2
 ---
 
 ## Environmental variables
diff --git a/docs/user/developing_with_rucio.md b/docs/user/developing_with_rucio.md
@@ -1,6 +1,7 @@
 ---
 id: developing_with_rucio
 title: Developing with Rucio
+sidebar_position: 5
 ---
 
 ## Rucio Clients
diff --git a/docs/user/setting_up_the_rucio_client.md b/docs/user/setting_up_the_rucio_client.md
@@ -1,5 +1,6 @@
 ---
 title: Setting Up the Rucio Client
+sidebar_position: 1
 ---
 
 ## Install via pip
diff --git a/docs/user/using_the_admin_client.md b/docs/user/using_the_admin_client.md
@@ -1,6 +1,7 @@
 ---
 id: using_the_admin_client
 title: "Using the Admin Client"
+sidebar_position: 4
 ---
 
 Rucio provides a CLI for administrative tasks. The get methods can be executed
diff --git a/docs/user/using_the_client.md b/docs/user/using_the_client.md
@@ -1,6 +1,7 @@
 ---
 id: using_the_client
 title: Using the Client
+sidebar_position: 3
 ---
 
 Rucio provides several commands for the end-user. See [executables](bin/rucio.md).
diff --git a/website/sidebars.json b/website/sidebars.json
@@ -2,69 +2,28 @@
     "docs": [
         "index",
         {
-            "Getting Started": [
-                "started/before_you_get_started",
-                "started/what_is_rucio",
-                {
-                    "type": "category",
-                    "label": "Main Components",
-                    "link": {
-                        "type": "doc",
-                        "id": "started/main_components"
-                        },
-                    "items": [
-                        "started/daemons"
-                    ]
-                },
-                "started/additional_layers_and_resources",
-                "started/requirements",
-                {
-                    "Concepts": [
-                        "started/concepts/rucio_account",
-                        "started/concepts/file_dataset_container",
-                        "started/concepts/rucio_storage_element",
-                        "started/concepts/metadata_attributes",
-                        "started/concepts/permission_model",
-                        "started/concepts/replica_management",
-                        "started/concepts/replication_rules_examples",
-                        "started/concepts/rse_expressions",
-                        "started/concepts/accounting_and_quota",
-                        "started/concepts/notifications",
-                        "started/concepts/subscriptions",
-                        "started/concepts/replica_workflow",
-                        "started/concepts/deletion_overview"
-                    ]
-                },
-                "started/releasepolicy",
+            "label": "Getting Started", 
+            "type": "category",
+            "items": [
+                {"type": "autogenerated", "dirName": "started"}, 
                 "release-notes"
-            ],
-            "User": [
-                "user/setting_up_the_rucio_client",
-                "user/configuring_the_client",
-                "user/using_the_client",
-                "user/using_the_admin_client",
-                "user/developing_with_rucio"
-            ],
-            "Operator": [
-                "operator/setting_up_demo",
-                "operator/kubernetes",
-                "operator/installing_server",
-                "operator/installing_daemons",
-                "operator/configuration",
-                "operator/k8s_guide",
-                "operator/multi_vo_rucio",
-                "operator/monitoring",
-                "operator/database",
-                "operator/administration",
-                "operator/configuration_parameters",
+            ]
+        }, 
+        {
+            "label": "User", 
+            "type": "category",
+            "items": [{"type": "autogenerated", "dirName": "user"}]
+        }, 
+        {
+            "label": "Operator", 
+            "type": "category",
+            "items": [
+                {"type": "autogenerated", "dirName": "operator"}, 
                 {
-                    "Transfers": [
-                        "operator/transfers/transfers-overview",
-                        "operator/transfers/transfers-preparer",
-                        "operator/transfers/transfers-throttler",
-                        "operator/transfers/transfers-submitter",
-                        "operator/transfers/configure-rucio-globus",
-                        "operator/transfers/configure-rucio-fts3-plugins", 
+                    "type": "category", 
+                    "label": "Transfers", 
+                    "items": [
+                        {"type": "autogenerated", "dirName": "transfers"}, 
                         { 
                             "type": "link", 
                             "label": "TransferTools API",
@@ -76,50 +35,30 @@
                             "href": "pathname:///html/transfer_protocols/posix.html"
                         }
                     ]
-                },
-                "operator/did_meta",
-                "operator/policy_packages",
-                "operator/s3_rse_config",
-                "operator/qos_rse_config",
-                "operator/notifications",
-		"operator/suspicious-replica-recoverer", 
+                }, 
                 {
-                    "label":"Executables", 
-                    "type": "category",
-                    "link": {
-                        "type": "generated-index",
-                        "title": "Executables"
-                    },
+                    "type": "category", 
+                    "label": "Executables", 
                     "items": [{"type": "autogenerated", "dirName": "bin"}]
                 }
-            ],
-            "Developer": [
-		"developer/setting_up_mac_apple_silicon",
-                "developer/setting_up_intellij_dev_env",
-                "developer/setting_up_vscode_dev_env",
-                "contributing",
-		"developer/dependency_management",
-                "developer/project_structure",
-                "developer/rest_api_doc",
-                "developer/type_annotation_guide",
-                "developer/sprint_planning",
-                "developer/dev_style_guide",
-                {
-                    "WebUI": [
-                        "developer/webui/webui_frontend_vscode_dev_env",
-                        "developer/webui/streamedtables",
-                        "developer/webui/webui_frontend"
-                    ]
-                }
-            ],
-            "About Us": [
+            
+            ]
+        }, 
+        {
+            "label": "Developer", 
+            "type": "category",
+            "items": [{"type": "autogenerated", "dirName": "developer"}]
+        }, 
+        {
+            "label": "About Us", 
+            "type": "category", 
+            "items": [
                 "project_organisation",
                 "rucio_advisory_board",
                 "component_leads",
                 "special_interest_groups",
                 "about_our_contributors",
-                "contact_us"
-            ]
+                "contact_us"]
         }
     ]
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "label": "Web UI",
 +    "collapsible": true
 +}