docs(tweak): Put skeleton deploy config into includes file

armory · Oct 25, 2023 · 2e08e0f · 2e08e0f
1 parent 200b2d5
commit 2e08e0f
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 11 deletions.
diff --git a/content/en/deployment/create-deploy-config.md b/content/en/deployment/create-deploy-config.md
@@ -16,6 +16,10 @@ Make sure you have [installed the CD-as-a-Service CLI]({{< ref "cli" >}}), which
 
 {{< include "create-config.md" >}}
 
+## Deployment config file example
+
+{{< include "dep-file/skeleton-config.md" >}}
+
 ## {{% heading "nextSteps" %}}
 
 * {{< linkWithTitle "reference/deployment/config-file/_index.md" >}}
diff --git a/content/en/includes/dep-file/deploy-example.yaml b/content/en/includes/dep-file/deploy-example.yaml
@@ -36,7 +36,7 @@ targets:
               - <queryName2>
       afterDeployment:
         - pause:
-            untilApproved: true 
+            untilApproved: true
             requiresRoles:
               - <role-name>
             approvalExpiration:

diff --git a/content/en/includes/dep-file/skeleton-config.md b/content/en/includes/dep-file/skeleton-config.md
@@ -0,0 +1,6 @@
+Expand to see a skeleton config file for a deployment to Kubernetes. All all config options are listed for each section. 
+
+<details><summary><b>Click to view a skeleton deployment config file</b></summary>
+<br>
+{{< readfile file="/includes/dep-file/deploy-example.yaml" code="true" lang="yaml" >}}
+</details>
diff --git a/content/en/reference/deployment/_index.md b/content/en/reference/deployment/_index.md
@@ -51,11 +51,10 @@ armory template kubernetes [template-type] > deployment-template.yaml
 {{< include "create-config.md" >}}
 
 
-<details><summary>Show me an example deployment file</summary>
-This file is in the <a href="https://github.com/armory/docs-cdaas-sample" target="_blank">armory/docs-cdaas-sample repo</a>.
+## Deployment config file example
+
+{{< include "dep-file/skeleton-config.md" >}}
 
-{{< github repo="armory/docs-cdaas-sample" file="/deploy.yml" lang="yaml" options="" >}}
-</details><br>
 
 ## {{% heading "nextSteps" %}}
 

diff --git a/content/en/reference/deployment/config-file/_index.md b/content/en/reference/deployment/config-file/_index.md
@@ -8,12 +8,9 @@ categories: ["Reference"]
 tags: ["Deployment", "Deploy Config"]
 ---
 
-<details><summary>Show an example deploy config file</summary>
-<br>
-The following is a skeleton for a deployment to Kubernetes. All all config options are listed for each section. 
+## Deployment config file example
 
-{{< readfile file="/includes/dep-file/deploy-example.yaml" code="true" lang="yaml" >}}
-</details>
+{{< include "dep-file/skeleton-config.md" >}}
 
 
 

diff --git a/content/en/remote-network-agent/install-helm.md b/content/en/remote-network-agent/install-helm.md
@@ -46,7 +46,7 @@ Installation using Helm consists of the following steps:
 1. [Generate and preview the manifests](#generate-and-preview-the-manifests)
 1. [Install the RNA](#install-the-rna)
 
-<details><summary>Show the values file</summary>
+<details><summary>Click to view the values file</summary>
 {{< github repo="armory-io/remote-network-agent-helm-chart" file="/values.yaml" lang="yaml" options="" >}}
 </details><br>