docs: config file reference (#977)

* Remove redundant "reference" word from titles in files and therefore navbar * Move config file references to their own folder, config-files. * Reference config-files folder in the navbar. * Use absolute path references to config files
canonical · Jan 17, 2025 · 5ac109a · 5ac109a
1 parent 3d1340c
commit 5ac109a
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 8 deletions.
diff --git a/...p/reference/bootstrap-config-reference.md → ...eference/config-files/bootstrap-config.md b/...p/reference/bootstrap-config-reference.md → ...eference/config-files/bootstrap-config.md
@@ -1,4 +1,4 @@
-# Bootstrap configuration file reference
+# Bootstrap configuration file
 
 A YAML file can be supplied to the `k8s join-cluster` command to configure and
 customise the cluster. This reference section provides the format of this file

diff --git a/...ce/control-plane-join-config-reference.md → ...config-files/control-plane-join-config.md b/...ce/control-plane-join-config-reference.md → ...config-files/control-plane-join-config.md
@@ -1,4 +1,4 @@
-# Control plane node join configuration file reference
+# Control plane node join configuration file
 
 A YAML file can be supplied to the `k8s join-cluster ` command to configure and
 customise new nodes.
@@ -7,5 +7,5 @@ This reference section provides all available options for control plane nodes.
 
 ## Configuration options
 
-```{include} ../../_parts/control_plane_join_config.md
+```{include} /src/_parts/control_plane_join_config.md
 ```
diff --git a/docs/src/snap/reference/config-files/index.md b/docs/src/snap/reference/config-files/index.md
@@ -0,0 +1,20 @@
+# Configuration files
+
+```{toctree}
+:hidden:
+Configuration Files <self>
+```
+
+{{product}} uses several configuration files to control its behavior and
+settings. Links below provides detailed information about each configuration
+file.
+
+```{toctree}
+:glob:
+:titlesonly:
+
+Install from a snap <snap.md>
+bootstrap-config
+control-plane-join-config
+worker-join-config
+```
diff --git a/...reference/worker-join-config-reference.md → ...erence/config-files/worker-join-config.md b/...reference/worker-join-config-reference.md → ...erence/config-files/worker-join-config.md
@@ -1,4 +1,4 @@
-# Worker node join configuration file reference
+# Worker node join configuration file
 
 A YAML file can be supplied to the `k8s join-cluster ` command to configure and
 customise new worker nodes.
@@ -7,5 +7,5 @@ This reference section provides all available options for worker nodes.
 
 ## Configuration options
 
-```{include} ../../_parts/worker_join_config.md
+```{include} /src/_parts/worker_join_config.md
 ```
diff --git a/docs/src/snap/reference/index.md b/docs/src/snap/reference/index.md
@@ -12,13 +12,11 @@ Overview <self>
 :titlesonly:
 
 releases
+config-files/index
 commands
 ports-and-services
 annotations
 certificates
-bootstrap-config-reference
-control-plane-join-config-reference
-worker-join-config-reference
 proxy
 troubleshooting
 architecture