Skip to content

Commit

Permalink
doc: update synopsis to monospace
Browse files Browse the repository at this point in the history
  • Loading branch information
siakhooi committed May 14, 2023
1 parent 59007be commit 9f12b8c
Show file tree
Hide file tree
Showing 19 changed files with 85 additions and 47 deletions.
4 changes: 3 additions & 1 deletion docs/shed-aliases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ List aliases used by shed programs.

## SYNOPSIS

**shed-aliases**
```bash
shed-aliases
```

## EXAMPLES

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-config-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-config-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Print environment variables used by shed programs.

## SYNOPSIS

**shed-env**
**shed env**
```bash
shed-env
shed env
```

## SCREENSHOTS

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-istioctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 8 additions & 6 deletions docs/shed-kubeconfig-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-kubectl-exec-bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-kubectl-exec-sh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-kubectl-logs-follow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-kubectl-scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/shed-kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-list-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/shed-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Set the environment to use **shedCode** as current Shed.

## SYNOPSIS

**shed-use** shedCode
```bash
shed-use shedCode
```

## SCREENSHOTS

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-value-key-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-value.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/shed-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Print all config values of current shed.

## SYNOPSIS

**shed-values**
**shed values**
```bash
shed-values
shed values
```

## SCREENSHOTS

Expand Down

0 comments on commit 9f12b8c

Please sign in to comment.