Merge pull request #26 from Prateeknandle/fix-doc-4

fix the broken documentation
kubearmor · Apr 1, 2024 · 717ae8d · 717ae8d
2 parents 7e2cbdd + e49f64e
commit 717ae8d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 13 deletions.
diff --git a/.web-docs/README.md b/.web-docs/README.md
@@ -1,5 +1,3 @@
-# KubeArmor
-
 A plugin for Packer which provides [KubeArmor Hardening Host Security policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide) for the build workloads.
 
 > [KubeArmor](https://docs.kubearmor.io/kubearmor/) is a security solution for the Kubernetes and cloud native platforms that helps protect your workloads from attacks and threats. It does this by providing a set of hardening policies that are based on industry-leading compliance and attack frameworks such as CIS, MITRE, NIST-800-53, and STIGs. These policies are designed to help you secure your workloads in a way that is compliant with these frameworks and recommended best practices.
@@ -49,7 +47,7 @@ on [installing a plugin](https://developer.hashicorp.com/packer/docs/plugins/ins
 
 ## Components
 
-### Provisioners
+### Provisioners:
 
 - [kubearmor](/packer/integrations/kubearmor/kubearmor/latest/components/provisioner/kubearmor) - The kubearmor provisioner is used to provisioner
   Packer builds and provide the packer builds KubeArmor Host Security Policies.
diff --git a/.web-docs/components/provisioner/kubearmor/README.md b/.web-docs/components/provisioner/kubearmor/README.md
@@ -23,7 +23,7 @@ packer {
     }
     kubearmor = {
       version = ">= 0.0.1"
-      source = "github.com/hashicorp/kubearmor"
+      source = "github.com/kubearmor/kubearmor"
     }
   }
 }
@@ -61,7 +61,7 @@ packer {
     }
     kubearmor = {
       version = ">= 0.0.1"
-      source = "github.com/hashicorp/kubearmor"
+      source = "github.com/kubearmor/kubearmor"
     }
   }
 }

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,3 @@
-# KubeArmor
-
 A plugin for Packer which provides [KubeArmor Hardening Host Security policies](https://docs.kubearmor.io/kubearmor/use-cases/hardening_guide) for the build workloads.
 
 > [KubeArmor](https://docs.kubearmor.io/kubearmor/) is a security solution for the Kubernetes and cloud native platforms that helps protect your workloads from attacks and threats. It does this by providing a set of hardening policies that are based on industry-leading compliance and attack frameworks such as CIS, MITRE, NIST-800-53, and STIGs. These policies are designed to help you secure your workloads in a way that is compliant with these frameworks and recommended best practices.
@@ -49,7 +47,7 @@ on [installing a plugin](https://developer.hashicorp.com/packer/docs/plugins/ins
 
 ## Components
 
-### Provisioners
+### Provisioners:
 
 - [kubearmor](/packer/integrations/kubearmor/kubearmor/latest/components/provisioner/kubearmor) - The kubearmor provisioner is used to provisioner
   Packer builds and provide the packer builds KubeArmor Host Security Policies.
diff --git a/docs/provisioners/kubearmor.mdx b/docs/provisioners/kubearmor.mdx
@@ -1,11 +1,11 @@
 ---
-description: >
+description: |
   The kubearmor provisioner is used to configure the packer builds by deploying KubeArmor Host Security Policies and providing KubeArmor and other tools necessary to apply policies.
 page_title: KubeArmor - Provisioners
-nav_title: kubearmor
+nav_title: KubeArmor
 ---
 
-# KubeArmor - Provisioners
+# KubeArmor Provisioner
 
 Type: `kubearmor`
 
@@ -32,7 +32,7 @@ packer {
     }
     kubearmor = {
       version = ">= 0.0.1"
-      source = "github.com/hashicorp/kubearmor"
+      source = "github.com/kubearmor/kubearmor"
     }
   }
 }
@@ -70,7 +70,7 @@ packer {
     }
     kubearmor = {
       version = ">= 0.0.1"
-      source = "github.com/hashicorp/kubearmor"
+      source = "github.com/kubearmor/kubearmor"
     }
   }
 }