added pandoc

Author: enrichman

.github/workflows/test-e2e.yaml

@@ -20,8 +20,12 @@ jobs:
       with:
         go-version-file: go.mod
 
+    - name: Install Pandoc
+      run: sudo apt-get install pandoc
+
     - name: Validate
       run: make validate
+
   tests-e2e:
     runs-on: ubuntu-latest
     needs: validate

.github/workflows/test.yaml

@@ -37,6 +37,9 @@ jobs:
       with:
         go-version-file: go.mod
 
+    - name: Install Pandoc
+      run: sudo apt-get install pandoc
+
     - name: Validate
       run: make validate
 

docs/cli/k3kcli.adoc

@@ -10,6 +10,23 @@ CLI for K3K.
       --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
 ----
 
+== k3kcli cluster
+
+K3k cluster command.
+
+=== Options
+
+----
+  -h, --help   help for cluster
+----
+
+=== Options inherited from parent commands
+
+----
+      --debug               Turn on debug logs
+      --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
+----
+
 == k3kcli cluster create
 
 Create a new cluster.
@@ -116,14 +133,14 @@ k3kcli cluster list [command options]
       --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
 ----
 
-== k3kcli cluster
+== k3kcli kubeconfig
 
-K3k cluster command.
+Manage kubeconfig for clusters.
 
 === Options
 
 ----
-  -h, --help   help for cluster
+  -h, --help   help for kubeconfig
 ----
 
 === Options inherited from parent commands
@@ -162,14 +179,14 @@ k3kcli kubeconfig generate [flags]
       --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
 ----
 
-== k3kcli kubeconfig
+== k3kcli policy
 
-Manage kubeconfig for clusters.
+K3k policy command.
 
 === Options
 
 ----
-  -h, --help   help for kubeconfig
+  -h, --help   help for policy
 ----
 
 === Options inherited from parent commands
@@ -264,20 +281,3 @@ k3kcli policy list [command options]
       --debug               Turn on debug logs
       --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
 ----
-
-== k3kcli policy
-
-K3k policy command.
-
-=== Options
-
-----
-  -h, --help   help for policy
-----
-
-=== Options inherited from parent commands
-
-----
-      --debug               Turn on debug logs
-      --kubeconfig string   kubeconfig path ($HOME/.kube/config or $KUBECONFIG if set)
-----

scripts/generate-cli-docs

@@ -4,13 +4,39 @@ set -eou pipefail
 
 DOCS_DIR=./docs/cli
 
-
+# Generate the raw markdown files
 go run $DOCS_DIR/genclidoc.go
 
 echo "Converting Markdown documentation to asciidoc"
 
 pandoc --from markdown --to asciidoc --lua-filter=$DOCS_DIR/convert.lua $DOCS_DIR/k3kcli.md > $DOCS_DIR/k3kcli.adoc
 echo "" >> $DOCS_DIR/k3kcli.adoc
-pandoc --from markdown --to asciidoc --lua-filter=$DOCS_DIR/convert.lua $DOCS_DIR/k3kcli_*.md >> $DOCS_DIR/k3kcli.adoc
+
+# We use an explicit list of files to keep a stable ordering
+SUBCOMMAND_FILES=(
+    "$DOCS_DIR/k3kcli_cluster.md"
+    "$DOCS_DIR/k3kcli_cluster_create.md"
+    "$DOCS_DIR/k3kcli_cluster_delete.md"
+    "$DOCS_DIR/k3kcli_cluster_list.md"
+    "$DOCS_DIR/k3kcli_kubeconfig.md"
+    "$DOCS_DIR/k3kcli_kubeconfig_generate.md"
+    "$DOCS_DIR/k3kcli_policy.md"
+    "$DOCS_DIR/k3kcli_policy_create.md"
+    "$DOCS_DIR/k3kcli_policy_delete.md"
+    "$DOCS_DIR/k3kcli_policy_list.md"
+)
+
+# Check for newly added doc files
+EXPECTED_COUNT=${#SUBCOMMAND_FILES[@]}
+ACTUAL_COUNT=$(ls -1 $DOCS_DIR/k3kcli_*.md | wc -l)
+
+if [ "$EXPECTED_COUNT" -ne "$ACTUAL_COUNT" ]; then
+    echo "ERROR: File count mismatch!"
+    echo "Expected $EXPECTED_COUNT files in the array, but found $ACTUAL_COUNT on disk."
+    echo "Please update the SUBCOMMAND_FILES array in $0"
+    exit 1
+fi
+
+pandoc --from markdown --to asciidoc --lua-filter=$DOCS_DIR/convert.lua "${SUBCOMMAND_FILES[@]}">> $DOCS_DIR/k3kcli.adoc
 
 echo "Asciidoc documentation generated at $DOCS_DIR/k3kcli.adoc"