update doc: polish see also

siakhooi · Apr 30, 2024 · 51e0946 · 51e0946
1 parent 907572d
commit 51e0946
Show file tree

Hide file tree

Showing 32 changed files with 114 additions and 37 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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)
+- [shed-kubectl-apply](shed-kubectl-apply.md)
+- [shed-kubectl-delete](shed-kubectl-delete.md)
+- [~/.shed/kubectl-resources](directory-kubectl-resources.md)
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -11,4 +11,4 @@ shed version
 
 ## SEE ALSO
 
-[shed](shed.md)
+- [shed](shed.md)