Refactor paths (#1944)

## Description To prepare the repo for documentation migration and to improve the discoverability of scripts for generating docs, I've renamed `hack/` to `scripts/` and moved the `.templates/` folder with the JSFH configs into `scripts/` path. This will make doc conversion much cleaner and make it easier to find things.
zarf-dev · Aug 4, 2023 · 79d5021 · 79d5021
1 parent 95bd3ea
commit 79d5021
Show file tree

Hide file tree

Showing 69 changed files with 68 additions and 68 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -36,7 +36,9 @@ repos:
         files: "src/types/types.go"
         types: [go]
         language: script
-        description: "Runs `zarf internal config-schema > zarf.schema.json` to ensure schema is up to date"
+        description:
+          "Runs `zarf internal config-schema > zarf.schema.json` to ensure
+          schema is up to date"
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.14.0
     hooks:

diff --git a/Makefile b/Makefile
@@ -91,7 +91,7 @@ build-cli-linux: build-cli-linux-amd build-cli-linux-arm ## Build the Zarf CLI f
 build-cli: build-cli-linux-amd build-cli-linux-arm build-cli-mac-intel build-cli-mac-apple build-cli-windows-amd build-cli-windows-arm ## Build the CLI
 
 docs-and-schema: ensure-ui-build-dir ## Generate the Zarf Documentation and Schema
-	docs/gen-cli-docs.sh
+	hack/gen-cli-docs.sh
 	ZARF_CONFIG=hack/empty-config.toml hack/create-zarf-schema.sh
 
 dev: ensure-ui-build-dir ## Start a Dev Server for the Zarf UI
@@ -213,7 +213,7 @@ test-cves: ensure-ui-build-dir
 	go run main.go tools sbom packages . -o json --exclude './docs-website' | grype --fail-on low
 
 cve-report: ensure-ui-build-dir ## Create a CVE report for the current project (must `brew install grype` first)
-	go run main.go tools sbom packages . -o json --exclude './docs-website' | grype -o template -t hack/grype.tmpl > build/zarf-known-cves.csv
+	go run main.go tools sbom packages . -o json --exclude './docs-website' | grype -o template -t hack/.templates/grype.tmpl > build/zarf-known-cves.csv
 
 lint-go: ## Run revive to lint the go code (must `brew install revive` first)
 	revive -config revive.toml -exclude src/cmd/viper.go -formatter stylish ./src/...
diff --git a/docs/.templates/jsfh-config.json b/docs/.templates/jsfh-config.json
diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf.md b/docs/2-the-zarf-cli/100-cli-commands/zarf.md
@@ -1,5 +1,5 @@
 # zarf
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 DevSecOps for Airgap
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md
@@ -1,5 +1,5 @@
 # zarf completion
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate the autocompletion script for the specified shell
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md
@@ -1,5 +1,5 @@
 # zarf completion bash
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate the autocompletion script for bash
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md
@@ -1,5 +1,5 @@
 # zarf completion fish
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate the autocompletion script for fish
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md
@@ -1,5 +1,5 @@
 # zarf completion powershell
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate the autocompletion script for powershell
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md
@@ -1,5 +1,5 @@
 # zarf completion zsh
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate the autocompletion script for zsh
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md
@@ -1,5 +1,5 @@
 # zarf connect
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Accesses services or pods deployed in the cluster
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md
@@ -1,5 +1,5 @@
 # zarf connect list
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Lists all available connection shortcuts
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md
@@ -1,5 +1,5 @@
 # zarf destroy
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Tears down Zarf and removes its components from the environment
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md
@@ -1,5 +1,5 @@
 # zarf init
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Prepares a k8s cluster for the deployment of Zarf packages
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md
@@ -1,5 +1,5 @@
 # zarf package
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Zarf package commands for creating, deploying, and inspecting packages
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md
@@ -1,5 +1,5 @@
 # zarf package create
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Creates a Zarf package from a given directory or the current directory
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md
@@ -1,5 +1,5 @@
 # zarf package deploy
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Deploys a Zarf package from a local file or URL (runs offline)
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md
@@ -1,5 +1,5 @@
 # zarf package inspect
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Displays the definition of a Zarf package (runs offline)
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md
@@ -1,5 +1,5 @@
 # zarf package list
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Lists out all of the packages that have been deployed to the cluster (runs offline)
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md
@@ -1,5 +1,5 @@
 # zarf package publish
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Publishes a Zarf package to a remote registry
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md
@@ -1,5 +1,5 @@
 # zarf package pull
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Pulls a Zarf package from a remote registry and save to the local file system
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md
@@ -1,5 +1,5 @@
 # zarf package remove
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Removes a Zarf package that has been deployed already (runs offline)
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare.md
@@ -1,5 +1,5 @@
 # zarf prepare
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Tools to help prepare assets for packaging
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_find-images.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_find-images.md
@@ -1,5 +1,5 @@
 # zarf prepare find-images
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Evaluates components in a zarf file to identify images specified in their helm charts and manifests
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_generate-config.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_generate-config.md
@@ -1,5 +1,5 @@
 # zarf prepare generate-config
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generates a config file for Zarf
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_patch-git.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_patch-git.md
@@ -1,5 +1,5 @@
 # zarf prepare patch-git
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE.  NOTE:
 This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_sha256sum.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_prepare_sha256sum.md
@@ -1,5 +1,5 @@
 # zarf prepare sha256sum
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generates a SHA256SUM for the given file
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md
@@ -1,5 +1,5 @@
 # zarf tools
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Collection of additional tools to make airgap easier
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md
@@ -1,5 +1,5 @@
 # zarf tools archiver
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Compresses/Decompresses generic archives, including Zarf packages
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md
@@ -1,5 +1,5 @@
 # zarf tools archiver compress
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Compresses a collection of sources based off of the destination file extension.
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md
@@ -1,5 +1,5 @@
 # zarf tools archiver decompress
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Decompresses an archive or Zarf package based off of the source file extension.
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md
@@ -1,5 +1,5 @@
 # zarf tools clear-cache
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Clears the configured git and image cache directory
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md
@@ -1,5 +1,5 @@
 # zarf tools download-init
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Downloads the init package for the current Zarf version into the specified directory
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md
@@ -1,5 +1,5 @@
 # zarf tools gen-key
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generates a cosign public/private keypair that can be used to sign packages
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md
@@ -1,5 +1,5 @@
 # zarf tools gen-pki
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generates a Certificate Authority and PKI chain of trust for the given host
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md
@@ -1,5 +1,5 @@
 # zarf tools get-creds
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Displays a Table of credentials for deployed components. Pass a component name to get a single credential
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_kubectl.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_kubectl.md
@@ -1,5 +1,5 @@
 # zarf tools kubectl
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Kubectl command. See https://kubernetes.io/docs/reference/kubectl/overview/ for more information.
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_monitor.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_monitor.md
@@ -1,5 +1,5 @@
 # zarf tools monitor
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Launches a terminal UI to monitor the connected cluster using K9s.
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry.md
@@ -1,5 +1,5 @@
 # zarf tools registry
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Tools for working with container registries using go-containertools
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_catalog.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_catalog.md
@@ -1,5 +1,5 @@
 # zarf tools registry catalog
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 List the repos in a registry
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_copy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_copy.md
@@ -1,5 +1,5 @@
 # zarf tools registry copy
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Efficiently copy a remote image from src to dst while retaining the digest value
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_login.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_login.md
@@ -1,5 +1,5 @@
 # zarf tools registry login
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Log in to a registry
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_ls.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_ls.md
@@ -1,5 +1,5 @@
 # zarf tools registry ls
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 List the tags in a repo
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_pull.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_pull.md
@@ -1,5 +1,5 @@
 # zarf tools registry pull
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Pull remote images by reference and store their contents locally
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_push.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_push.md
@@ -1,5 +1,5 @@
 # zarf tools registry push
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Push local image contents to a remote registry
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom.md
@@ -1,5 +1,5 @@
 # zarf tools sbom
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generates a Software Bill of Materials (SBOM) for the given package
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_attest.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_attest.md
@@ -1,5 +1,5 @@
 # zarf tools sbom attest
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate an SBOM as an attestation for the given [SOURCE] container image
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_convert.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_convert.md
@@ -1,5 +1,5 @@
 # zarf tools sbom convert
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Convert between SBOM formats
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_login.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_login.md
@@ -1,5 +1,5 @@
 # zarf tools sbom login
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Log in to a registry
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_packages.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_packages.md
@@ -1,5 +1,5 @@
 # zarf tools sbom packages
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Generate a package SBOM
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_version.md
@@ -1,5 +1,5 @@
 # zarf tools sbom version
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 show the version
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_wait-for.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_wait-for.md
@@ -1,5 +1,5 @@
 # zarf tools wait-for
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Waits for a given Kubernetes resource to be ready
 

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md
@@ -1,5 +1,5 @@
 # zarf version
-<!-- Auto-generated by docs/gen-cli-docs.sh -->
+<!-- Auto-generated by hack/gen-cli-docs.sh -->
 
 Shows the version of the running Zarf binary
 

diff --git a/hack/grype.tmpl → hack/.templates/grype.tmpl b/hack/grype.tmpl → hack/.templates/grype.tmpl
diff --git a/hack/.templates/jsfh-config.json b/hack/.templates/jsfh-config.json
@@ -0,0 +1,11 @@
+{
+  "custom_template_path": "hack/.templates/jsonschemaforhumans/base.md",
+  "template_md_options": {
+    "badge_as_image": true,
+    "show_heading_numbers": false
+  },
+  "show_toc": false,
+  "show_breadcrumbs": false,
+  "footer_show_time": false,
+  "deprecated_from_description": true
+}
diff --git a/docs/.templates/jsonschemaforhumans/base.md → hack/.templates/jsonschemaforhumans/base.md b/docs/.templates/jsonschemaforhumans/base.md → hack/.templates/jsonschemaforhumans/base.md
diff --git a/...plates/jsonschemaforhumans/breadcrumbs.md → ...plates/jsonschemaforhumans/breadcrumbs.md b/...plates/jsonschemaforhumans/breadcrumbs.md → ...plates/jsonschemaforhumans/breadcrumbs.md
diff --git a/....templates/jsonschemaforhumans/content.md → ....templates/jsonschemaforhumans/content.md b/....templates/jsonschemaforhumans/content.md → ....templates/jsonschemaforhumans/content.md
diff --git a/...ates/jsonschemaforhumans/section_array.md → ...ates/jsonschemaforhumans/section_array.md b/...ates/jsonschemaforhumans/section_array.md → ...ates/jsonschemaforhumans/section_array.md
diff --git a/...orhumans/section_conditional_subschema.md → ...orhumans/section_conditional_subschema.md b/...orhumans/section_conditional_subschema.md → ...orhumans/section_conditional_subschema.md
diff --git a/...sonschemaforhumans/section_description.md → ...sonschemaforhumans/section_description.md b/...sonschemaforhumans/section_description.md → ...sonschemaforhumans/section_description.md
diff --git a/...s/jsonschemaforhumans/section_examples.md → ...s/jsonschemaforhumans/section_examples.md b/...s/jsonschemaforhumans/section_examples.md → ...s/jsonschemaforhumans/section_examples.md
diff --git a/...plates/jsonschemaforhumans/section_not.md → ...plates/jsonschemaforhumans/section_not.md b/...plates/jsonschemaforhumans/section_not.md → ...plates/jsonschemaforhumans/section_not.md
diff --git a/...tes/jsonschemaforhumans/section_one_of.md → ...tes/jsonschemaforhumans/section_one_of.md b/...tes/jsonschemaforhumans/section_one_of.md → ...tes/jsonschemaforhumans/section_one_of.md
diff --git a/...maforhumans/section_properties_details.md → ...maforhumans/section_properties_details.md b/...maforhumans/section_properties_details.md → ...maforhumans/section_properties_details.md
diff --git a/...ction_undocumented_required_properties.md → ...ction_undocumented_required_properties.md b/...ction_undocumented_required_properties.md → ...ction_undocumented_required_properties.md
diff --git a/...tes/jsonschemaforhumans/tabbed_section.md → ...tes/jsonschemaforhumans/tabbed_section.md b/...tes/jsonschemaforhumans/tabbed_section.md → ...tes/jsonschemaforhumans/tabbed_section.md
diff --git a/hack/create-zarf-schema.sh b/hack/create-zarf-schema.sh
@@ -7,4 +7,4 @@ go run main.go internal config-schema > zarf.schema.json
 go run main.go internal api-schema | npx quicktype -s schema -o src/ui/lib/api-types.ts
 
 # Create docs from the zarf.yaml JSON schema
-docker run -v $(pwd):/app -w /app --rm python:3.8-alpine /bin/sh -c "pip install json-schema-for-humans && generate-schema-doc --config-file docs/.templates/jsfh-config.json zarf.schema.json docs/3-create-a-zarf-package/4-zarf-schema.md"
+docker run -v $(pwd):/app -w /app --rm python:3.8-alpine /bin/sh -c "pip install json-schema-for-humans && generate-schema-doc --config-file hack/.templates/jsfh-config.json zarf.schema.json docs/3-create-a-zarf-package/4-zarf-schema.md"