docs: extend documentation (bank-vaults#216)

* docs: add helm chart docs Signed-off-by: Ramiz Polić <[email protected]> * docs: add OpenSSF Best Practices badge Signed-off-by: Ramiz Polić <[email protected]> * docs: update helm chart readme Signed-off-by: Ramiz Polić <[email protected]> * feat: update helm docs Signed-off-by: Ramiz Polic <[email protected]> Signed-off-by: Ramiz Polić <[email protected]> * fix: helm installation guide Signed-off-by: Ramiz Polic <[email protected]> Signed-off-by: Ramiz Polić <[email protected]> * docs: fix helm readme template Signed-off-by: Ramiz Polić <[email protected]> --------- Signed-off-by: Ramiz Polić <[email protected]> Signed-off-by: Ramiz Polic <[email protected]>
tanmay-pnaik · Nov 24, 2023 · 9a36e0b · 9a36e0b
1 parent 88d0282
commit 9a36e0b
Show file tree

Hide file tree

Showing 5 changed files with 387 additions and 148 deletions.
diff --git a/Makefile b/Makefile
@@ -106,7 +106,7 @@ generate: ## Run generation jobs
 
 .PHONY: generate-helm-docs
 generate-helm-docs:
-	helm-docs -s file -c charts/ -t README.md.gotmpl
+	helm-docs -s file -c deploy/charts/ -t README.md.gotmpl
 
 deps: bin/golangci-lint bin/licensei bin/kind bin/kurun bin/helm-docs
 deps: ## Install dependencies

diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bank-vaults/vault-secrets-webhook/ci.yaml?style=flat-square)](https://github.com/bank-vaults/vault-secrets-webhook/actions/workflows/ci.yaml)
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/bank-vaults/vault-secrets-webhook/badge?style=flat-square)](https://api.securityscorecards.dev/projects/github.com/bank-vaults/vault-secrets-webhook)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7961/badge)](https://www.bestpractices.dev/projects/7961)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/vault-secrets-webhook)](https://artifacthub.io/packages/search?repo=vault-secrets-webhook)
 
 **A Kubernetes mutating webhook that makes direct secret injection into Pods possible.**