From 61393bc8d12938ebdacffa23b1972854acae2276 Mon Sep 17 00:00:00 2001
From: Joe McCormick <31295332+iamjoemccormick@users.noreply.github.com>
Date: Thu, 2 Jan 2025 22:21:13 +0000
Subject: [PATCH] docs: clarify connDisableAuthentication value requires quotes

---
 .github/workflows/build-test-publish.yaml |  7 +++++--
 README.md                                 |  2 +-
 docs/deployment.md                        | 12 ++++++++----
 3 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/build-test-publish.yaml b/.github/workflows/build-test-publish.yaml
index 307317d8..f670fcf4 100644
--- a/.github/workflows/build-test-publish.yaml
+++ b/.github/workflows/build-test-publish.yaml
@@ -11,8 +11,11 @@ on:
     branches:
       - "master"
     paths-ignore:
-      - "**/*.md"
-      - "**/*.txt"
+      - "CHANGELOG.md"    
+      - "CONTRIBUTING.md"  
+      - "README.md"
+      - "SECURITY.md"
+      - 'docs/**'
 
 env:
   # Equivalent of BUILD_PLATFORMS in the Makefile and release-tools build.make. We cannot just set
diff --git a/README.md b/README.md
index 4b62a41e..9154acd2 100644
--- a/README.md
+++ b/README.md
@@ -194,7 +194,7 @@ deployment guide](operator/README.md).
      ```yaml
      config:
        beegfsClientConf:
-         connDisableAuthentication: true
+         connDisableAuthentication: "true" # note the quotes are required
      ```
    * Provide connAuth details in `csi-beegfs-connauth.yaml` if your existing
      file system does use connection authentication.
diff --git a/docs/deployment.md b/docs/deployment.md
index 234e96ad..6da09eaf 100644
--- a/docs/deployment.md
+++ b/docs/deployment.md
@@ -783,10 +783,14 @@ parameter falls under determines its level of support in the driver.
 
 Special attention should be paid to these parameters.
 
-* `connDisableAuthentication` - Added in BeeGFS v7.3.1 and BeeGFS v7.2.7. If the
-  file system the BeeGFS client will connect to does not use connAuth files,
-  this must be set to `true`.
-
+* `connDisableAuthentication` - Added in BeeGFS v7.3.1 and BeeGFS v7.2.7. If the file system the
+  BeeGFS client will connect to does not use connAuth files, this must be set to `"true"`.
+  * Note: To avoid YAML interpeting the value as a native boolean, it must be enclosed in double
+    quotes or you will get an error like:
+    
+    ```
+    failed to handle configuration file: likely missing quotes around an integer or boolean beegfsClientConf value: error unmarshaling JSON: while decoding JSON: json: cannot unmarshal bool into Go struct field BeegfsConfig.config.beegfsClientConf of type string`
+    ```
 
 <a name="no-effect"></a>
 #### No Effect