diff --git a/docs/src/snap/reference/bootstrap-config-reference.md b/docs/src/snap/reference/config-files/bootstrap-config.md similarity index 95% rename from docs/src/snap/reference/bootstrap-config-reference.md rename to docs/src/snap/reference/config-files/bootstrap-config.md index e2ca3f26c..bcc6837b1 100644 --- a/docs/src/snap/reference/bootstrap-config-reference.md +++ b/docs/src/snap/reference/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/docs/src/snap/reference/control-plane-join-config-reference.md b/docs/src/snap/reference/config-files/control-plane-join-config.md similarity index 63% rename from docs/src/snap/reference/control-plane-join-config-reference.md rename to docs/src/snap/reference/config-files/control-plane-join-config.md index 06875521a..58737e41e 100755 --- a/docs/src/snap/reference/control-plane-join-config-reference.md +++ b/docs/src/snap/reference/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 new file mode 100644 index 000000000..1a24d5201 --- /dev/null +++ b/docs/src/snap/reference/config-files/index.md @@ -0,0 +1,20 @@ +# Configuration files + +```{toctree} +:hidden: +Configuration Files +``` + +{{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 +bootstrap-config +control-plane-join-config +worker-join-config +``` diff --git a/docs/src/snap/reference/worker-join-config-reference.md b/docs/src/snap/reference/config-files/worker-join-config.md similarity index 66% rename from docs/src/snap/reference/worker-join-config-reference.md rename to docs/src/snap/reference/config-files/worker-join-config.md index d10ea5ba2..20d6ab4a0 100755 --- a/docs/src/snap/reference/worker-join-config-reference.md +++ b/docs/src/snap/reference/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 index dece9e831..6388f3772 100644 --- a/docs/src/snap/reference/index.md +++ b/docs/src/snap/reference/index.md @@ -12,13 +12,11 @@ Overview :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