From 51e0946957ed21158248d26abd7989740f1f7126 Mon Sep 17 00:00:00 2001 From: Siak Hooi <73884114+siakhooi@users.noreply.github.com> Date: Tue, 30 Apr 2024 01:39:49 +0000 Subject: [PATCH] update doc: polish see also --- docs/directory-init.d-shed-init.md | 5 +++-- docs/directory-init.d-shed-kubeconfig-use.md | 4 +++- docs/directory-init.d-shed-use.md | 4 +++- docs/directory-kubectl-config.md | 2 +- docs/directory-kubectl-resources.md | 4 +++- docs/file-shed-config.yaml.md | 10 ++++++++-- docs/shed-aliases.md | 2 +- docs/shed-config-edit.md | 4 +++- docs/shed-config-get.md | 6 +++++- docs/shed-config.md | 6 +++++- docs/shed-contexts.md | 5 ++++- docs/shed-env.md | 2 +- docs/shed-helm.md | 6 +++++- docs/shed-istioctl.md | 6 +++++- docs/shed-kubeconfig-use.md | 6 +++++- docs/shed-kubectl-apply.md | 4 +++- docs/shed-kubectl-delete.md | 4 +++- docs/shed-kubectl-exec-bash.md | 4 +++- docs/shed-kubectl-exec-sh.md | 4 +++- docs/shed-kubectl-logs-follow.md | 4 +++- docs/shed-kubectl-logs-previous.md | 4 +++- docs/shed-kubectl-resources.md | 4 +++- docs/shed-kubectl-scale.md | 3 ++- docs/shed-kubectl-secret-decode.md | 2 +- docs/shed-kubectl.md | 16 ++++++++++++---- docs/shed-list-code.md | 4 +++- docs/shed-list.md | 3 ++- docs/shed-use.md | 7 ++++++- docs/shed-value-key-list.md | 5 ++++- docs/shed-value.md | 3 ++- docs/shed-values.md | 6 +++++- docs/shed-version.md | 2 +- 32 files changed, 114 insertions(+), 37 deletions(-) diff --git a/docs/directory-init.d-shed-init.md b/docs/directory-init.d-shed-init.md index 496b5de..9e9c766 100644 --- a/docs/directory-init.d-shed-init.md +++ b/docs/directory-init.d-shed-init.md @@ -15,5 +15,6 @@ You can add in scripts to extend the functionally of Shed, for example: ## SEE ALSO -[~/.shed/config.yaml](file-shed-config.yaml.md), [~/.shed/init.d/shed-use](directory-init.d-shed-use.md), -[~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) +- [~/.shed/init.d/shed-use](directory-init.d-shed-use.md) +- [~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md) diff --git a/docs/directory-init.d-shed-kubeconfig-use.md b/docs/directory-init.d-shed-kubeconfig-use.md index 570538e..2587d13 100644 --- a/docs/directory-init.d-shed-kubeconfig-use.md +++ b/docs/directory-init.d-shed-kubeconfig-use.md @@ -14,4 +14,6 @@ You can add in scripts to extend the functionally of Shed, for example: ## SEE ALSO -[~/.shed/config.yaml](file-shed-config.yaml.md), [~/.shed/init.d/shed-init](directory-init.d-shed-init.md), [~/.shed/init.d/shed-use](directory-init.d-shed-use.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) +- [~/.shed/init.d/shed-init](directory-init.d-shed-init.md) +- [~/.shed/init.d/shed-use](directory-init.d-shed-use.md) diff --git a/docs/directory-init.d-shed-use.md b/docs/directory-init.d-shed-use.md index b74d5fa..351885b 100644 --- a/docs/directory-init.d-shed-use.md +++ b/docs/directory-init.d-shed-use.md @@ -14,4 +14,6 @@ You can add in scripts to extend the functionally of Shed, for example: ## SEE ALSO -[~/.shed/config.yaml](file-shed-config.yaml.md), [~/.shed/init.d/shed-init](directory-init.d-shed-init.md), [~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) +- [~/.shed/init.d/shed-init](directory-init.d-shed-init.md) +- [~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md) diff --git a/docs/directory-kubectl-config.md b/docs/directory-kubectl-config.md index 143ab23..1da1d37 100644 --- a/docs/directory-kubectl-config.md +++ b/docs/directory-kubectl-config.md @@ -10,4 +10,4 @@ This behaviour can be turned of by set `.shed-init.load-kubectl-config` to `no` ## SEE ALSO -[~/.shed/config.yaml](file-shed-config.yaml.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) diff --git a/docs/directory-kubectl-resources.md b/docs/directory-kubectl-resources.md index 5f7b7f8..cda0f3a 100644 --- a/docs/directory-kubectl-resources.md +++ b/docs/directory-kubectl-resources.md @@ -12,4 +12,6 @@ User defined kubectl resources that will be executed by `shed-kubectl-apply` and ## SEE ALSO -[shed-kubectl-resources](shed-kubectl-resources.md), [shed-kubectl-apply](shed-kubectl-apply.md), [shed-kubectl-delete](shed-kubectl-delete.md) +- [shed-kubectl-resources](shed-kubectl-resources.md) +- [shed-kubectl-apply](shed-kubectl-apply.md) +- [shed-kubectl-delete](shed-kubectl-delete.md) diff --git a/docs/file-shed-config.yaml.md b/docs/file-shed-config.yaml.md index 251fef4..cabd16d 100644 --- a/docs/file-shed-config.yaml.md +++ b/docs/file-shed-config.yaml.md @@ -52,5 +52,11 @@ shed-kubeconfig-use: ## SEE ALSO -[shed-config-edit](shed-config-edit.md), [shed-config-get](shed-config-get.md), [shed-config](shed-config.md), [shed](shed.md), [~/.shed/init.d/shed-init](directory-init.d-shed-init.md), [~/.shed/init.d/shed-use](directory-init.d-shed-use.md), [~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md), -[~/.shed/kubectl-config](directory-kubectl-config.md) +- [shed-config-edit](shed-config-edit.md) +- [shed-config-get](shed-config-get.md) +- [shed-config](shed-config.md) +- [shed](shed.md) +- [~/.shed/init.d/shed-init](directory-init.d-shed-init.md) +- [~/.shed/init.d/shed-use](directory-init.d-shed-use.md) +- [~/.shed/init.d/shed-kubeconfig-use](directory-init.d-shed-kubeconfig-use.md) +- [~/.shed/kubectl-config](directory-kubectl-config.md) diff --git a/docs/shed-aliases.md b/docs/shed-aliases.md index 85a1b4f..c5b7052 100644 --- a/docs/shed-aliases.md +++ b/docs/shed-aliases.md @@ -30,4 +30,4 @@ alias kd='shed-kubectl-delete' ## SEE ALSO -[shed-env](shed-env.md) +- [shed-env](shed-env.md) diff --git a/docs/shed-config-edit.md b/docs/shed-config-edit.md index 58aacad..a099463 100644 --- a/docs/shed-config-edit.md +++ b/docs/shed-config-edit.md @@ -29,4 +29,6 @@ export EDITOR=nano ## SEE ALSO -[shed-config](shed-config.md), [shed-config-get](shed-config-get.md), [~/.shed/config.yaml](file-shed-config.yaml.md) +- [shed-config](shed-config.md) +- [shed-config-get](shed-config-get.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) diff --git a/docs/shed-config-get.md b/docs/shed-config-get.md index 31b5042..8030efd 100644 --- a/docs/shed-config-get.md +++ b/docs/shed-config-get.md @@ -15,4 +15,8 @@ shed config-get yamlPath ## SEE ALSO -[shed-config-edit](shed-config-edit.md), [shed-config](shed-config.md), [shed-values](shed-values.md), [shed-value](shed-value.md), [~/.shed/config.yaml](file-shed-config.yaml.md) +- [shed-config-edit](shed-config-edit.md) +- [shed-config](shed-config.md) +- [shed-values](shed-values.md) +- [shed-value](shed-value.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) diff --git a/docs/shed-config.md b/docs/shed-config.md index 331d650..af437f8 100644 --- a/docs/shed-config.md +++ b/docs/shed-config.md @@ -15,4 +15,8 @@ shed config ## SEE ALSO -[shed-config-edit](shed-config-edit.md), [shed-config-get](shed-config-get.md), [shed-values](shed-values.md), [shed-value](shed-value.md), [~/.shed/config.yaml](file-shed-config.yaml.md) +- [shed-config-edit](shed-config-edit.md) +- [shed-config-get](shed-config-get.md) +- [shed-values](shed-values.md) +- [shed-value](shed-value.md) +- [~/.shed/config.yaml](file-shed-config.yaml.md) diff --git a/docs/shed-contexts.md b/docs/shed-contexts.md index 19b0a1f..dfc1b62 100644 --- a/docs/shed-contexts.md +++ b/docs/shed-contexts.md @@ -12,4 +12,7 @@ sc ## SEE ALSO -[shed-use](shed-use.md), [shed-values](shed-values.md), [shed-config](shed-config.md), [shed-config.yaml](file-shed-config.yaml.md) +- [shed-use](shed-use.md) +- [shed-values](shed-values.md) +- [shed-config](shed-config.md) +- [shed-config.yaml](file-shed-config.yaml.md) diff --git a/docs/shed-env.md b/docs/shed-env.md index ced5396..7b99fab 100644 --- a/docs/shed-env.md +++ b/docs/shed-env.md @@ -15,4 +15,4 @@ shed env ## SEE ALSO -[shed-config](shed-config.md) +- [shed-config](shed-config.md) diff --git a/docs/shed-helm.md b/docs/shed-helm.md index 13f46c3..8473644 100644 --- a/docs/shed-helm.md +++ b/docs/shed-helm.md @@ -21,4 +21,8 @@ h - alias to shed-helm ## SEE ALSO -[shed-config](shed-config.md), [shed-use](shed-use.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md), [shed-istioctl](shed-istioctl.md) +- [shed-config](shed-config.md) +- [shed-use](shed-use.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-istioctl](shed-istioctl.md) diff --git a/docs/shed-istioctl.md b/docs/shed-istioctl.md index b619f95..8a3bc58 100644 --- a/docs/shed-istioctl.md +++ b/docs/shed-istioctl.md @@ -29,4 +29,8 @@ $ shed-use D; shed-istioctl install ## SEE ALSO -[shed-config](shed-config.md), [shed-use](shed-use.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md), [shed-helm](shed-helm.md) +- [shed-config](shed-config.md) +- [shed-use](shed-use.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-helm](shed-helm.md) diff --git a/docs/shed-kubeconfig-use.md b/docs/shed-kubeconfig-use.md index b621852..02cf3c0 100644 --- a/docs/shed-kubeconfig-use.md +++ b/docs/shed-kubeconfig-use.md @@ -29,4 +29,8 @@ c4 - alias for **shed-kubeconfig-use 4** ## SEE ALSO -[shed-config](shed-config.md), [shed-use](shed-use.md), [shed-kubectl](shed-kubectl.md), [shed-helm](shed-helm.md), [shed-istioctl](shed-istioctl.md) +- [shed-config](shed-config.md) +- [shed-use](shed-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-helm](shed-helm.md) +- [shed-istioctl](shed-istioctl.md) diff --git a/docs/shed-kubectl-apply.md b/docs/shed-kubectl-apply.md index 13b7bed..d9748ea 100644 --- a/docs/shed-kubectl-apply.md +++ b/docs/shed-kubectl-apply.md @@ -20,4 +20,6 @@ pod/hello-world created ## SEE ALSO -[shed-kubectl-delete](shed-kubectl-delete.md), [shed-kubectl-resources](shed-kubectl-resources.md), [~/.shed/kubectl-resources](directory-kubectl-resources.md) +- [shed-kubectl-delete](shed-kubectl-delete.md) +- [shed-kubectl-resources](shed-kubectl-resources.md) +- [~/.shed/kubectl-resources](directory-kubectl-resources.md) diff --git a/docs/shed-kubectl-delete.md b/docs/shed-kubectl-delete.md index 1c0d2c9..a1f755a 100644 --- a/docs/shed-kubectl-delete.md +++ b/docs/shed-kubectl-delete.md @@ -20,4 +20,6 @@ pod/hello-world deleted ## SEE ALSO -[shed-kubectl-apply](shed-kubectl-apply.md), [shed-kubectl-resources](shed-kubectl-resources.md), [~/.shed/kubectl-resources](directory-kubectl-resources.md) +- [shed-kubectl-apply](shed-kubectl-apply.md) +- [shed-kubectl-resources](shed-kubectl-resources.md) +- [~/.shed/kubectl-resources](directory-kubectl-resources.md) diff --git a/docs/shed-kubectl-exec-bash.md b/docs/shed-kubectl-exec-bash.md index 176f6ea..4b3e36d 100644 --- a/docs/shed-kubectl-exec-bash.md +++ b/docs/shed-kubectl-exec-bash.md @@ -32,4 +32,6 @@ $ shed-kubectl-exec-bash pod/pod-abc container-1 ## SEE ALSO -[shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md), [shed-kubectl-exec-sh](shed-kubectl-exec-sh.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-kubectl-exec-sh](shed-kubectl-exec-sh.md) diff --git a/docs/shed-kubectl-exec-sh.md b/docs/shed-kubectl-exec-sh.md index e0bc5a0..2341663 100644 --- a/docs/shed-kubectl-exec-sh.md +++ b/docs/shed-kubectl-exec-sh.md @@ -32,4 +32,6 @@ $ shed-kubectl-exec-sh pod/pod-abc container-1 ## SEE ALSO -[shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md), [shed-kubectl-exec-bash](shed-kubectl-exec-bash.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-kubectl-exec-bash](shed-kubectl-exec-bash.md) diff --git a/docs/shed-kubectl-logs-follow.md b/docs/shed-kubectl-logs-follow.md index 7d91eda..9693b86 100644 --- a/docs/shed-kubectl-logs-follow.md +++ b/docs/shed-kubectl-logs-follow.md @@ -24,4 +24,6 @@ $ shed-use D; shed-kubectl-logs-follow pod/pod-abc container-1 ## SEE ALSO -[shed-kubectl-logs-previous](shed-kubectl-logs-previous.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md) +- [shed-kubectl-logs-previous](shed-kubectl-logs-previous.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) diff --git a/docs/shed-kubectl-logs-previous.md b/docs/shed-kubectl-logs-previous.md index c1c1f59..0b8ecf0 100644 --- a/docs/shed-kubectl-logs-previous.md +++ b/docs/shed-kubectl-logs-previous.md @@ -24,4 +24,6 @@ $ shed-use D; shed-kubectl-logs-previous pod/pod-abc container-1 ## SEE ALSO -[shed-kubectl-logs-follow](shed-kubectl-logs-follow.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md) +- [shed-kubectl-logs-follow](shed-kubectl-logs-follow.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) diff --git a/docs/shed-kubectl-resources.md b/docs/shed-kubectl-resources.md index e2e61d6..3b262ff 100644 --- a/docs/shed-kubectl-resources.md +++ b/docs/shed-kubectl-resources.md @@ -17,4 +17,6 @@ hello-world ## SEE ALSO -[shed-kubectl-apply](shed-kubectl-apply.md), [shed-kubectl-delete](shed-kubectl-delete.md), [~/.shed/kubectl-resources](directory-kubectl-resources.md) \ No newline at end of file +- [shed-kubectl-apply](shed-kubectl-apply.md) +- [shed-kubectl-delete](shed-kubectl-delete.md) +- [~/.shed/kubectl-resources](directory-kubectl-resources.md) \ No newline at end of file diff --git a/docs/shed-kubectl-scale.md b/docs/shed-kubectl-scale.md index 706d41a..7575f63 100644 --- a/docs/shed-kubectl-scale.md +++ b/docs/shed-kubectl-scale.md @@ -24,4 +24,5 @@ $ shed-kubectl-scale 5 sts/maria-database-abc ## SEE ALSO -[shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) diff --git a/docs/shed-kubectl-secret-decode.md b/docs/shed-kubectl-secret-decode.md index 4e9cc92..f4129e9 100644 --- a/docs/shed-kubectl-secret-decode.md +++ b/docs/shed-kubectl-secret-decode.md @@ -24,4 +24,4 @@ value ## SEE ALSO -[shed-kubectl](shed-kubectl.md) +- [shed-kubectl](shed-kubectl.md) diff --git a/docs/shed-kubectl.md b/docs/shed-kubectl.md index f3a4627..c8186d4 100644 --- a/docs/shed-kubectl.md +++ b/docs/shed-kubectl.md @@ -17,7 +17,15 @@ k [kubectl arguments] ## SEE ALSO -[shed-config](shed-config.md), [shed-use](shed-use.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-helm](shed-helm.md), [shed-istioctl](shed-istioctl.md)\ -[shed-kubectl-exec-sh](shed-kubectl-exec-sh.md), [shed-kubectl-exec-bash](shed-kubectl-exec-bash.md), [shed-kubectl-scale](shed-kubectl-scale.md)\ -[shed-kubectl-resources](shed-kubectl-resources.md), [shed-kubectl-apply](shed-kubectl-apply.md), [shed-kubectl-delete](shed-kubectl-delete.md)\ -[shed-kubectl-secret-decode](shed-kubectl-secret-decode.md) +- [shed-config](shed-config.md) +- [shed-use](shed-use.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-helm](shed-helm.md) +- [shed-istioctl](shed-istioctl.md) +- [shed-kubectl-exec-sh](shed-kubectl-exec-sh.md) +- [shed-kubectl-exec-bash](shed-kubectl-exec-bash.md) +- [shed-kubectl-scale](shed-kubectl-scale.md) +- [shed-kubectl-resources](shed-kubectl-resources.md) +- [shed-kubectl-apply](shed-kubectl-apply.md) +- [shed-kubectl-delete](shed-kubectl-delete.md) +- [shed-kubectl-secret-decode](shed-kubectl-secret-decode.md) diff --git a/docs/shed-list-code.md b/docs/shed-list-code.md index 822a383..7771f57 100644 --- a/docs/shed-list-code.md +++ b/docs/shed-list-code.md @@ -15,4 +15,6 @@ shed list-code ## SEE ALSO -[shed-config](shed-config.md), [shed-list](shed-list.md), [shed-use](shed-use.md) +- [shed-config](shed-config.md) +- [shed-list](shed-list.md) +- [shed-use](shed-use.md) diff --git a/docs/shed-list.md b/docs/shed-list.md index 80cd5b6..2708e77 100644 --- a/docs/shed-list.md +++ b/docs/shed-list.md @@ -15,4 +15,5 @@ shed list ## SEE ALSO -[shed-config](shed-config.md), [shed-list-code](shed-list-code.md) +- [shed-config](shed-config.md) +- [shed-list-code](shed-list-code.md) diff --git a/docs/shed-use.md b/docs/shed-use.md index a6d44da..7bc83c7 100644 --- a/docs/shed-use.md +++ b/docs/shed-use.md @@ -14,4 +14,9 @@ shed-use shedCode ## SEE ALSO -[shed-config](shed-config.md), [shed-list-code](shed-list-code.md), [shed-kubeconfig-use](shed-kubeconfig-use.md), [shed-kubectl](shed-kubectl.md), [shed-helm](shed-helm.md), [shed-istioctl](shed-istioctl.md) +- [shed-config](shed-config.md) +- [shed-list-code](shed-list-code.md) +- [shed-kubeconfig-use](shed-kubeconfig-use.md) +- [shed-kubectl](shed-kubectl.md) +- [shed-helm](shed-helm.md) +- [shed-istioctl](shed-istioctl.md) diff --git a/docs/shed-value-key-list.md b/docs/shed-value-key-list.md index db6b0fb..eac680a 100644 --- a/docs/shed-value-key-list.md +++ b/docs/shed-value-key-list.md @@ -15,4 +15,7 @@ shed value-key-list ## SEE ALSO -[shed-config](shed-config.md), [shed-values](shed-values.md), [shed-value](shed-value.md), [shed](shed.md) +- [shed-config](shed-config.md) +- [shed-values](shed-values.md) +- [shed-value](shed-value.md) +- [shed](shed.md) diff --git a/docs/shed-value.md b/docs/shed-value.md index c0156fc..2b3d0a7 100644 --- a/docs/shed-value.md +++ b/docs/shed-value.md @@ -15,4 +15,5 @@ shed value yamlPath ## SEE ALSO -[shed-values](shed-values.md), [shed-config](shed-config.md) +- [shed-values](shed-values.md) +- [shed-config](shed-config.md) diff --git a/docs/shed-values.md b/docs/shed-values.md index d129d21..b747a7f 100644 --- a/docs/shed-values.md +++ b/docs/shed-values.md @@ -15,4 +15,8 @@ shed values ## SEE ALSO -[shed-value](shed-value.md), [shed-config](shed-config.md), [shed-config.yaml](file-shed-config.yaml.md), [shed-value-key-list](shed-value-key-list.md), [shed-contexts](shed-contexts.md) +- [shed-value](shed-value.md) +- [shed-config](shed-config.md) +- [shed-config.yaml](file-shed-config.yaml.md) +- [shed-value-key-list](shed-value-key-list.md) +- [shed-contexts](shed-contexts.md) diff --git a/docs/shed-version.md b/docs/shed-version.md index 16c8753..a4268d0 100644 --- a/docs/shed-version.md +++ b/docs/shed-version.md @@ -11,4 +11,4 @@ shed version ## SEE ALSO -[shed](shed.md) +- [shed](shed.md)