From f47478e514c247ca1d8ca1962e756216a23845ee Mon Sep 17 00:00:00 2001
From: Allan Carter <cartalla@amazon.com>
Date: Mon, 28 Oct 2024 19:55:15 +0000
Subject: [PATCH] Update docs for ClusterConfig

Add pointer to ParallelCluster config file doc.

Add an example of how to set a parameter.

Resolves #272
---
 docs/config.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/config.md b/docs/config.md
index e37e0e9..05b67a4 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -307,6 +307,19 @@ This will will be used to create the initial ParallelCluster configuration and o
 
 This exists to enable further customization of ParallelCluster beyond what this configuration supports.
 
+The [cluster configuration format](https://docs.aws.amazon.com/parallelcluster/latest/ug/cluster-configuration-file-v3.html) is documented in the ParallelCluster User Guide.
+
+For example, if you want to change the [ScaledownIdletime](https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-ScaledownIdletime), you would add the following to your config file.
+
+```
+slurm:
+  ParallelClusterConfig:
+    ClusterConfig:
+      Scheduling:
+        SlurmSettings:
+          ScaledownIdletime: 20
+```
+
 #### Image
 
 The OS and AMI to use for the head node and compute nodes.