feat(docs): add GA4 and restructure docs

README.md

@@ -15,17 +15,17 @@
 
 ## Features
 * Support KV version 1 & version 2 (no need to specify the version `vkv` will automatically detect the engines version)
-* **CI/CD Integrations for [Gitlab, GitHub, Azure Devops](https://falcosuessgott.github.io/vkv/cicd/gitlab/)**
+* **CI/CD Integrations for [Gitlab, GitHub, Azure Devops](https://falcosuessgott.github.io/vkv/cicd_gitlab)**
 * support all Vault Auth Env Vars and `VKV_LOGIN_COMMAND` for avoiding having to hardcode the `VAULT_TOKEN` ([example](https://falcosuessgott.github.io/vkv/authentication/))
-* recursively print secrets of any KV  Engine in `json`, `yaml`, `markdown` and [other formats](https://falcosuessgott.github.io/vkv/export/formats/)
+* recursively print secrets of any KV  Engine in `json`, `yaml`, `markdown` and [other formats](https://falcosuessgott.github.io/vkv/export_formats/)
 * engine export shows the secret version as well as its [custom metadata](https://developer.hashicorp.com/vault/docs/commands/kv/metadata)
 * customize the output (show only-keys, only-paths, mask/unmask secrets) via [flags or environment](https://falcosuessgott.github.io/vkv/export/)
 * print the CRUD-capabilities of the authenticated token for each KV-path (format: `policy`)
 * print secrets in `export <key>=<value>` format for env var exporting (format: `export`)
-* [import](https://falcosuessgott.github.io/vkv/06_import/) secrets back to Vault from `vkv`'s `json` or `yaml` format output
-* save and restore KVv2 snapshots (including namespaces) ([kubernetes](https://falcosuessgott.github.io/vkv/advanced_examples/kubernetes/) example)
-* list all KVv2-engines or namespaces for scripting purposes ([fzf](https://falcosuessgott.github.io/vkv/advanced_examples/fzf/) example)
-* more handy [snippets](https://falcosuessgott.github.io/vkv/advanced_examples/diff/) using `fzf`, `sops` & `diff`,
+* [import](https://falcosuessgott.github.io/vkv/import/) secrets back to Vault from `vkv`'s `json` or `yaml` format output
+* save and restore KVv2 snapshots (including namespaces) ([kubernetes](https://falcosuessgott.github.io/vkv/example_kubernetes/) example)
+* list all KVv2-engines or namespaces for scripting purposes ([fzf](https://falcosuessgott.github.io/vkv/example_fzf/) example)
+* more handy [snippets](https://falcosuessgott.github.io/vkv/example_diff/) using `fzf`, `sops` & `diff`,
 
 Checkout the [Quickstart](https://falcosuessgott.github.io/vkv/quickstart/) Guide to learn more about `vkv`
 

docs/authentication/index.md → docs/authentication.md

@@ -1,13 +1,15 @@
+# Authentication
+
 `vkv` supports all of Vaults [environment variables](https://www.vaultproject.io/docs/commands#environment-variables). In order to authenticate you will have to set at least `VAULT_ADDR` and `VAULT_TOKEN`.
 
-### MacOS/Linux
+## MacOS/Linux
 ```
 export VAULT_ADDR="http://127.0.0.1:8200"
 export VAULT_TOKEN="hvs.XXX" 
 vkv export --path <KVv2-path>
 ```
 
-### Windows
+## Windows
 ```
 SET VAULT_ADDR=http://127.0.0.1:8200
 SET VAULT_TOKEN=s.XXX

docs/configuration/index.md → docs/configuration.md

@@ -1,6 +1,7 @@
+# Configuration
 `vkv` and  all its subcommands are highly configurable using environment variables.
 
-Checkout the subcommands documentation aswell as the help messages (`vkv <subcommand> --help`) to see the available environment variables.
+Checkout the subcommands documentation as well as the help messages (`vkv <subcommand> --help`) to see the available environment variables.
 
 ## Mode
 You can control the executed subcommand of `vkv` by setting `VKV_MODE` to either on of:

docs/development/index.md → docs/development.md

@@ -1,3 +1,4 @@
+# Development
 Clone this repository and run:
 
 ```sh

docs/advanced_examples/diff.md → docs/example_diff.md

@@ -1,4 +1,4 @@
-
+# diff
 `vkv` can be used to compare secrets across Vault servers or KV engines.
 
 ```bash
@@ -8,4 +8,4 @@
 Here is an example using `diff`, the `|` indicates the changed entry per line:
 
 ## Demo
-![gif](../assets/diff.gif)
+![gif](assets/diff.gif)

docs/advanced_examples/direnv.md → docs/example_direnv.md

@@ -1,9 +1,10 @@
+# direnv
 You can use `vkv` and [`direnv`](https://direnv.net/) to autimatically source KV secrets in your shell.
 
-### Prerequisites
+## Prerequisites
 * Install [direnv](https://direnv.net/) and hook into your shell
 
-### Demo
+## Demo
 
 Create in a project a `.envrc` file:
 ```bash

docs/advanced_examples/fzf.md → docs/example_fzf.md

@@ -1,3 +1,5 @@
+# fzf
+
 using `vault secrets list` and a little bit of `jq`-logic, we can get a list of all KV-engines visible for the token. 
 
 If we pipe this into `fzf` we can get a handy little  preview-app:
@@ -7,4 +9,4 @@ vkv list engines --all --include-ns-prefix | fzf --preview 'vkv export -e ${}'
 ```
 
 ## Demo
-![gif](../assets/fzf.gif)
+![gif](assets/fzf.gif)

docs/advanced_examples/kubernetes.md → docs/example_kubernetes.md

@@ -1,19 +1,20 @@
+# Kubernetes
+
 `vkv` comes in container images, which enable you to run scheduled snapshots in a kubernetes cluster. 
 
 The idea is to schedule a cronjob which snapshots a vault server and writes the snapshot files to a persistent volume.
 
 Here is a minimum working `k3s` using `local-storage` example:
 
-
-### create the volume directories
+## create the volume directories
 
 ```bash
 # on a k3s node
 mkdir -p /data/volume/pv1
 chmod 777 /data/volume/pv1 # for testing
 ```
 
-### create a pv
+## create a pv
 
 ```yaml
 apiVersion: v1
@@ -39,7 +40,7 @@ spec:
           - worker-node # change
 ```
 
-### create a pvc
+## create a pvc
 ```yaml
 kind: PersistentVolumeClaim
 apiVersion: v1
@@ -54,7 +55,7 @@ spec:
       storage: 5Gi
 ```
 
-### create a cronjob
+## create a cronjob
 ```yaml
 apiVersion: batch/v1
 kind: CronJob
@@ -90,7 +91,7 @@ spec:
                 claimName: pvc
 ```
 
-### verify snapshots
+## verify snapshots
 if everything went correct, you should see the following:
 
 ```bash
@@ -100,7 +101,7 @@ drwxr-xr-x. 2 root root 108  5. Jan 09:50 vkv-export-20230105095000
 drwxr-xr-x. 2 root root 108  5. Jan 09:51 vkv-export-20230105095100
 ```
 
-### some last thoughts
+## some last thoughts
 Obviously this approach is just for development purposes. In order to make it production ready, you should consider changing some things, such as:
 
 * inject the environments from a ConfigMap

docs/advanced_examples/sops.md → docs/example_sops.md

@@ -1,10 +1,12 @@
+# sops
+
 In order to store the secret export created by `vkv` [sops](https://github.com/mozilla/sops#encrypting-using-hashicorp-vault) can be used.
 This example shows how to encrypt & decrypt `vkv` exported secrets using `sops` and Vaults transit engine:
 
-### Prerequisites
+## Prerequisites
 * Install [sops](https://github.com/mozilla/sops/releases)
 
-### Demo
+## Demo
 ```bash
 export VAULT_ADDR="https://vault.server"
 export VAULT_TOKEN="hvs.XXXX"

docs/export/index.md → docs/export.md

@@ -1,3 +1,4 @@
+# Export
 ## vkv export
 
 recursively list secrets from Vaults KV2 engine in various formats
@@ -23,9 +24,3 @@ vkv export [flags]
   -f, --format string            available output formats: "base", "json", "yaml", "export", "policy", "markdown", "template" (env: VKV_EXPORT_FORMAT) (default "base")
   -h, --help                     help for export
 ```
-
-### SEE ALSO
-
-* [vkv](vkv.md)	 - the swiss army knife when working with Vault KVv2 engines
-
-###### Auto generated by spf13/cobra on 19-Nov-2023

docs/import/index.md → docs/import.md

@@ -1,3 +1,4 @@
+# Import
 # vkv import
 
 import secrets from vkv's json or yaml output
@@ -19,15 +20,9 @@ vkv import [flags]
   -s, --silent                 do not output secrets (env: VKV_IMPORT_SILENT)
 ```
 
-### SEE ALSO
-
-* [vkv](vkv.md)	 - the swiss army knife when working with Vault KVv2 engines
-
-###### Auto generated by spf13/cobra on 19-Nov-2023
-
 ## read secrets from STDIN 
 
-The `-` in `vkv import -`, tells `vkv` do read data via STDIN. The idea of `vkv import -` is, in order to copy/mirror KV-v2 secrets or complete engines across diferrent Vault Servers or Namespaces, you can simply pipe 
+The `-` in `vkv import -`, tells `vkv` do read data via STDIN. The idea of `vkv import -` is, in order to copy/mirror KV-v2 secrets or complete engines across different Vault Servers or Namespaces, you can simply pipe 
 `vkv`s output into the `vkv import` command:
 
 ```bash

docs/index.md

@@ -15,16 +15,16 @@
 
 ## Features
 * Support KV version 1 & version 2 (no need to specify the version `vkv` will automatically detect the engines version)
-* **CI/CD Integrations for [Gitlab, GitHub, Azure Devops](https://falcosuessgott.github.io/vkv/cicd/gitlab/)**
+* **CI/CD Integrations for [Gitlab, GitHub, Azure Devops](https://falcosuessgott.github.io/vkv/cicd_gitlab)**
 * support all Vault Auth Env Vars and `VKV_LOGIN_COMMAND` for avoiding having to hardcode the `VAULT_TOKEN` ([example](https://falcosuessgott.github.io/vkv/authentication/))
-* recursively print secrets of any KV Engine in `json`, `yaml`, `markdown` and [other formats](https://falcosuessgott.github.io/vkv/export/formats/)
+* recursively print secrets of any KV  Engine in `json`, `yaml`, `markdown` and [other formats](https://falcosuessgott.github.io/vkv/export_formats/)
 * engine export shows the secret version as well as its [custom metadata](https://developer.hashicorp.com/vault/docs/commands/kv/metadata)
 * customize the output (show only-keys, only-paths, mask/unmask secrets) via [flags or environment](https://falcosuessgott.github.io/vkv/export/)
 * print the CRUD-capabilities of the authenticated token for each KV-path (format: `policy`)
 * print secrets in `export <key>=<value>` format for env var exporting (format: `export`)
-* [import](https://falcosuessgott.github.io/vkv/06_import/) secrets back to Vault from `vkv`'s `json` or `yaml` format output
-* save and restore KVv2 snapshots (including namespaces) ([kubernetes](https://falcosuessgott.github.io/vkv/advanced_examples/kubernetes/) example)
-* list all KVv2-engines or namespaces for scripting purposes ([fzf](https://falcosuessgott.github.io/vkv/advanced_examples/fzf/) example)
-* more handy [snippets](https://falcosuessgott.github.io/vkv/advanced_examples/diff/) using `fzf`, `sops` & `diff`,
+* [import](https://falcosuessgott.github.io/vkv/import/) secrets back to Vault from `vkv`'s `json` or `yaml` format output
+* save and restore KVv2 snapshots (including namespaces) ([kubernetes](https://falcosuessgott.github.io/vkv/example_kubernetes/) example)
+* list all KVv2-engines or namespaces for scripting purposes ([fzf](https://falcosuessgott.github.io/vkv/example_fzf/) example)
+* more handy [snippets](https://falcosuessgott.github.io/vkv/example_diff/) using `fzf`, `sops` & `diff`,
 
 Checkout the [Quickstart](https://falcosuessgott.github.io/vkv/quickstart/) Guide to learn more about `vkv`

docs/installation/index.md → docs/installation.md

@@ -1,4 +1,6 @@
-### cURL
+# Installation
+
+## cURL
 ```bash
 version=$(curl https://api.github.com/repos/falcosuessgott/vkv/releases/latest -s | jq .name -r)
 curl -OL "https://github.com/FalcoSuessgott/vkv/releases/download/${version}/vkv_$(uname)_$(uname -m).tar.gz"
@@ -7,7 +9,7 @@ chmod u+x vkv
 ./vkv version
 ```
 
-### Packages
+## Packages
 `vkv` is releases RPM- & DEB packages and Windows & MacOS Binaries.
 
 You can find and download all artifacts in the [release](https://github.com/FalcoSuessgott/vkv/releases) section.
@@ -27,21 +29,21 @@ tar xzf vkv_<version>.tar.gz
 chmod u+x ./vkv
 ```
 
-### Using `go`
+## Using `go`
 ```bash
 go install github.com/FalcoSuessgott/vkv@latest
 vkv
 ```
 
-### From Sources
+## From Sources
 ```bash
 # requires go to be installed
 git clone https://github.com/FalcoSuessgott/vkv
 cd vkv
 go install 
 ```
 
-### Docker
+## Docker
 ```bash
 # ghcr.io
 docker run -e VAULT_ADDR="${VAULT_ADDR}" -e VAULT_TOKEN="${VAULT_TOKEN}" ghcr.io/falcosuessgott/vkv

docs/engines/index.md → docs/list_engines.md

@@ -1,3 +1,4 @@
+# List Engines
 ## vkv list engines
 
 list all KVv2 engines
@@ -15,10 +16,4 @@ vkv list engines [flags]
   -a, --all                 list all KV engines recursively from the specified namespaces (env: VKV_LIST_ENGINES_ALL)
   -f, --format string       available output formats: "base", "json", "yaml" (env: VKV_LIST_ENGINES_FORMAT) (default "base")
   -h, --help                help for engines
-```
-
-### SEE ALSO
-
-* [vkv list](vkv_list.md)	 - list namespaces or KV engines
-
-###### Auto generated by spf13/cobra on 19-Nov-2023
+```

docs/namespaces/index.md → docs/list_namespaces.md

@@ -1,3 +1,5 @@
+# List Namespaces
+
 ## vkv list namespaces
 
 list all namespaces
@@ -14,10 +16,4 @@ vkv list namespaces [flags]
   -a, --all             list all namespaces recursively from the specified namespace (env: VKV_LIST_NAMESPACES_ALL)
   -f, --format string   available output formats: "base", "json", "yaml" (env: VKV_LIST_NAMESPACES_FORMAT (default "base")
   -h, --help            help for namespaces
-```
-
-### SEE ALSO
-
-* [vkv list](vkv_list.md)	 - list namespaces or KV engines
-
-###### Auto generated by spf13/cobra on 19-Nov-2023
+```