From 9f12b8ca121814e303c0eaba74d9b4070aa9de80 Mon Sep 17 00:00:00 2001 From: Siak Hooi <73884114+siakhooi@users.noreply.github.com> Date: Sun, 14 May 2023 03:34:52 +0000 Subject: [PATCH] doc: update synopsis to monospace --- docs/shed-aliases.md | 4 +++- docs/shed-config-edit.md | 6 ++++-- docs/shed-config-get.md | 6 ++++-- docs/shed-config.md | 6 ++++-- docs/shed-env.md | 6 ++++-- docs/shed-helm.md | 8 +++++--- docs/shed-istioctl.md | 8 +++++--- docs/shed-kubeconfig-use.md | 14 ++++++++------ docs/shed-kubectl-exec-bash.md | 8 +++++--- docs/shed-kubectl-exec-sh.md | 8 +++++--- docs/shed-kubectl-logs-follow.md | 8 +++++--- docs/shed-kubectl-scale.md | 8 +++++--- docs/shed-kubectl.md | 8 +++++--- docs/shed-list-code.md | 6 ++++-- docs/shed-list.md | 6 ++++-- docs/shed-use.md | 4 +++- docs/shed-value-key-list.md | 6 ++++-- docs/shed-value.md | 6 ++++-- docs/shed-values.md | 6 ++++-- 19 files changed, 85 insertions(+), 47 deletions(-) diff --git a/docs/shed-aliases.md b/docs/shed-aliases.md index bee5720..b540077 100644 --- a/docs/shed-aliases.md +++ b/docs/shed-aliases.md @@ -4,7 +4,9 @@ List aliases used by shed programs. ## SYNOPSIS -**shed-aliases** +```bash +shed-aliases +``` ## EXAMPLES diff --git a/docs/shed-config-edit.md b/docs/shed-config-edit.md index 06a7c77..58aacad 100644 --- a/docs/shed-config-edit.md +++ b/docs/shed-config-edit.md @@ -4,8 +4,10 @@ Edit shed config file using text editor defined in environment variable EDITOR, ## SYNOPSIS -**shed-config-edit** -**shed config-edit** +```bash +shed-config-edit +shed config-edit +``` ## DESCRIPTION diff --git a/docs/shed-config-get.md b/docs/shed-config-get.md index c362d0c..31b5042 100644 --- a/docs/shed-config-get.md +++ b/docs/shed-config-get.md @@ -4,8 +4,10 @@ get value from shed config file, _~/.shed/config.yaml_. ## SYNOPSIS -**shed-config-get** yamlPath -**shed config-get** yamlPath +```bash +shed-config-get yamlPath +shed config-get yamlPath +``` ## SCREENSHOTS diff --git a/docs/shed-config.md b/docs/shed-config.md index ddd058e..331d650 100644 --- a/docs/shed-config.md +++ b/docs/shed-config.md @@ -4,8 +4,10 @@ Print content of shed config file, ie: _~/.shed/config.yaml_. ## SYNOPSIS -**shed-config** -**shed config** +```bash +shed-config +shed config +``` ## SCREENSHOTS diff --git a/docs/shed-env.md b/docs/shed-env.md index 0427c08..ced5396 100644 --- a/docs/shed-env.md +++ b/docs/shed-env.md @@ -4,8 +4,10 @@ Print environment variables used by shed programs. ## SYNOPSIS -**shed-env** -**shed env** +```bash +shed-env +shed env +``` ## SCREENSHOTS diff --git a/docs/shed-helm.md b/docs/shed-helm.md index f30ebe8..13f46c3 100644 --- a/docs/shed-helm.md +++ b/docs/shed-helm.md @@ -4,9 +4,11 @@ Run helm command with context and/or namespace from current KubeConfig. ## SYNOPSIS -**shed-helm** [helm arguments]\ -**shed helm** [helm arguments]\ -**h** [helm arguments] +```bash +shed-helm [helm arguments] +shed helm [helm arguments] +h [helm arguments] +``` ## DESCRIPTION diff --git a/docs/shed-istioctl.md b/docs/shed-istioctl.md index a3c3d05..a087695 100644 --- a/docs/shed-istioctl.md +++ b/docs/shed-istioctl.md @@ -4,9 +4,11 @@ Run istioctl command with context and/or namespace from current KubeConfig. ## SYNOPSIS -**shed-istioctl** [istioctl arguments]\ -**shed istioctl** [istioctl arguments]\ -**i** [istioctl arguments] +```bash +shed-istioctl [istioctl arguments] +shed istioctl [istioctl arguments] +i [istioctl arguments] +``` ## DESCRIPTION diff --git a/docs/shed-kubeconfig-use.md b/docs/shed-kubeconfig-use.md index 1a637c3..b621852 100644 --- a/docs/shed-kubeconfig-use.md +++ b/docs/shed-kubeconfig-use.md @@ -5,12 +5,14 @@ Optional by configuration (_.shed-kubeconfig-use.kubectl-switch-context_), **she ## SYNOPSIS -**shed-kubeconfig-use** kubeconfig-number\ -**c0**\ -**c1**\ -**c2**\ -**c3**\ -**c4** +```bash +shed-kubeconfig-use kubeconfig-number +c0 +c1 +c2 +c3 +c4 +``` ## DESCRIPTION diff --git a/docs/shed-kubectl-exec-bash.md b/docs/shed-kubectl-exec-bash.md index 8349cf2..42dca5f 100644 --- a/docs/shed-kubectl-exec-bash.md +++ b/docs/shed-kubectl-exec-bash.md @@ -4,9 +4,11 @@ Run **bash** in kubernetes resource via **kubectl exec** with context and/or nam ## SYNOPSIS -**shed-kubectl-exec-bash** (pod | type/name) [container]\ -**shed kubectl-exec-bash** (pod | type/name) [container]\ -**k-bash** (pod | type/name) [container] +```bash +shed-kubectl-exec-bash (pod | type/name) [container] +shed kubectl-exec-bash (pod | type/name) [container] +k-bash (pod | type/name) [container] +``` ## EXAMPLES diff --git a/docs/shed-kubectl-exec-sh.md b/docs/shed-kubectl-exec-sh.md index 2caec43..b3b38e8 100644 --- a/docs/shed-kubectl-exec-sh.md +++ b/docs/shed-kubectl-exec-sh.md @@ -4,9 +4,11 @@ Run **sh** in kubernetes resource via **kubectl exec** with context and/or names ## SYNOPSIS -**shed-kubectl-exec-sh** (pod | type/name) [container]\ -**shed kubectl-exec-sh** (pod | type/name) [container]\ -**k-sh** (pod | type/name) [container] +```bash +shed-kubectl-exec-sh (pod | type/name) [container] +shed kubectl-exec-sh (pod | type/name) [container] +k-sh (pod | type/name) [container] +``` ## EXAMPLES diff --git a/docs/shed-kubectl-logs-follow.md b/docs/shed-kubectl-logs-follow.md index 5b74a52..f796152 100644 --- a/docs/shed-kubectl-logs-follow.md +++ b/docs/shed-kubectl-logs-follow.md @@ -4,9 +4,11 @@ Run **kubectl logs** with follow flag (`-f`) and `--tail=0` in context and/or na ## SYNOPSIS -**shed-kubectl-logs-follow** (pod | type/name) [container]\ -**shed kubectl-logs-follow** (pod | type/name) [container]\ -**k-logs-f** (pod | type/name) [container] +```bash +shed-kubectl-logs-follow (pod | type/name) [container] +shed kubectl-logs-follow (pod | type/name) [container] +k-logs-f (pod | type/name) [container] +``` ## EXAMPLES diff --git a/docs/shed-kubectl-scale.md b/docs/shed-kubectl-scale.md index 9f3f1e2..9513a4f 100644 --- a/docs/shed-kubectl-scale.md +++ b/docs/shed-kubectl-scale.md @@ -4,9 +4,11 @@ Run **kubectl scale** with the given resource and replicas in the context and/or ## SYNOPSIS -**shed-kubectl-scale** replicas resourceName\ -**shed kubectl-scale** replicas resourceName\ -**k-scale** replicas resourceName +```bash +shed-kubectl-scale replicas resourceName +shed kubectl-scale replicas resourceName +k-scale replicas resourceName +``` ## EXAMPLES diff --git a/docs/shed-kubectl.md b/docs/shed-kubectl.md index 123ee52..f11ad38 100644 --- a/docs/shed-kubectl.md +++ b/docs/shed-kubectl.md @@ -4,9 +4,11 @@ Run **kubectl** command with context and/or namespace from current KubeConfig. ## SYNOPSIS -**shed-kubectl** [kubectl arguments]\ -**shed kubectl** [kubectl arguments]\ -**k** [kubectl arguments] +```bash +shed-kubectl [kubectl arguments] +shed kubectl [kubectl arguments] +k [kubectl arguments] +``` ## SCREENSHOTS diff --git a/docs/shed-list-code.md b/docs/shed-list-code.md index 10b7e0a..822a383 100644 --- a/docs/shed-list-code.md +++ b/docs/shed-list-code.md @@ -4,8 +4,10 @@ Print list of shed codes, configured in the _~/.shed/config.yaml_. Use by `shed- ## SYNOPSIS -**shed-list-code** -**shed list-code** +```bash +shed-list-code +shed list-code +``` ## SCREENSHOTS diff --git a/docs/shed-list.md b/docs/shed-list.md index 0eae0d5..80cd5b6 100644 --- a/docs/shed-list.md +++ b/docs/shed-list.md @@ -4,8 +4,10 @@ Print list of sheds' code and name, configured in the _~/.shed/config.yaml_. ## SYNOPSIS -**shed-list** -**shed list** +```bash +shed-list +shed list +``` ## SCREENSHOTS diff --git a/docs/shed-use.md b/docs/shed-use.md index d0d372b..a6d44da 100644 --- a/docs/shed-use.md +++ b/docs/shed-use.md @@ -4,7 +4,9 @@ Set the environment to use **shedCode** as current Shed. ## SYNOPSIS -**shed-use** shedCode +```bash +shed-use shedCode +``` ## SCREENSHOTS diff --git a/docs/shed-value-key-list.md b/docs/shed-value-key-list.md index c95b02c..db6b0fb 100644 --- a/docs/shed-value-key-list.md +++ b/docs/shed-value-key-list.md @@ -4,8 +4,10 @@ Print list of keys of Shed values. Use by `shed-value` for completion logic. ## SYNOPSIS -**shed-value-key-list**\ -**shed value-key-list** +```bash +shed-value-key-list +shed value-key-list +``` ## SCREENSHOTS diff --git a/docs/shed-value.md b/docs/shed-value.md index 8d8fd75..c0156fc 100644 --- a/docs/shed-value.md +++ b/docs/shed-value.md @@ -4,8 +4,10 @@ Get the config value of current shed. ## SYNOPSIS -**shed-value** yamlPath -**shed value** yamlPath +```bash +shed-value yamlPath +shed value yamlPath +``` ## SCREENSHOTS diff --git a/docs/shed-values.md b/docs/shed-values.md index c3dbc13..e2143c6 100644 --- a/docs/shed-values.md +++ b/docs/shed-values.md @@ -4,8 +4,10 @@ Print all config values of current shed. ## SYNOPSIS -**shed-values** -**shed values** +```bash +shed-values +shed values +``` ## SCREENSHOTS