Skip to content

Commit

Permalink
Merge pull request #9622 from priyawadhwa/help
Browse files Browse the repository at this point in the history 
Update docs to include --help flag
  • Loading branch information
priyawadhwa authored Nov 6, 2020
2 parents 9afe7c6 + 760ad89 commit 18b0c00
Show file tree
Hide file tree
Showing 27 changed files with 55 additions and 205 deletions.
39 changes: 7 additions & 32 deletions site/content/en/docs/commands/addons.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,13 @@ addons modifies minikube addons files using subcommands like "minikube addons en
minikube addons SUBCOMMAND [flags]
```

### Options

```
-h, --help help for addons
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -55,18 +50,13 @@ Configures the addon w/ADDON_NAME within minikube (example: minikube addons conf
minikube addons configure ADDON_NAME [flags]
```

### Options

```
-h, --help help for configure
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -93,18 +83,13 @@ Disables the addon w/ADDON_NAME within minikube (example: minikube addons disabl
minikube addons disable ADDON_NAME [flags]
```

### Options

```
-h, --help help for disable
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -131,18 +116,13 @@ Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable
minikube addons enable ADDON_NAME [flags]
```

### Options

```
-h, --help help for enable
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -170,18 +150,13 @@ Simply type addons help [path to command] for full details.
minikube addons help [command] [flags]
```

### Options

```
-h, --help help for help
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -211,7 +186,6 @@ minikube addons list [flags]
### Options

```
-h, --help help for list
-o, --output string minikube addons list --output OUTPUT. json, list (default "list")
```

Expand All @@ -221,6 +195,7 @@ minikube addons list [flags]
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -251,7 +226,6 @@ minikube addons open ADDON_NAME [flags]

```
--format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}")
-h, --help help for open
--https Open the addons URL with https instead of http
--interval int The time interval for each check that wait performs in seconds (default 1)
--url Display the Kubernetes addons URL in the CLI instead of opening it in the default browser
Expand All @@ -264,6 +238,7 @@ minikube addons open ADDON_NAME [flags]
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down
37 changes: 6 additions & 31 deletions site/content/en/docs/commands/cache.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,13 @@ Add, delete, or push a local image into minikube

Add, delete, or push a local image into minikube

### Options

```
-h, --help help for cache
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -51,18 +46,13 @@ Add an image to local cache.
minikube cache add [flags]
```

### Options

```
-h, --help help for add
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -89,18 +79,13 @@ Delete an image from the local cache.
minikube cache delete [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -128,18 +113,13 @@ Simply type cache help [path to command] for full details.
minikube cache help [command] [flags]
```

### Options

```
-h, --help help for help
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -171,7 +151,6 @@ minikube cache list [flags]
```
--format string Go template format string for the cache list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#CacheListTemplate (default "{{.CacheImage}}\n")
-h, --help help for list
```

### Options inherited from parent commands
Expand All @@ -180,6 +159,7 @@ minikube cache list [flags]
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -206,18 +186,13 @@ reloads images previously added using the 'cache add' subcommand
minikube cache reload [flags]
```

### Options

```
-h, --help help for reload
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down
7 changes: 1 addition & 6 deletions site/content/en/docs/commands/completion.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,13 @@ Outputs minikube shell completion for the given shell (bash, zsh or fish)
minikube completion SHELL [flags]
```

### Options

```
-h, --help help for completion
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down
39 changes: 7 additions & 32 deletions site/content/en/docs/commands/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,13 @@ Configurable fields:
minikube config SUBCOMMAND [flags]
```

### Options

```
-h, --help help for config
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -91,7 +86,6 @@ minikube config defaults PROPERTY_NAME [flags]
### Options

```
-h, --help help for defaults
--output string Output format. Accepted values: [json]
```

Expand All @@ -101,6 +95,7 @@ minikube config defaults PROPERTY_NAME [flags]
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -127,18 +122,13 @@ Returns the value of PROPERTY_NAME from the minikube config file. Can be overwr
minikube config get PROPERTY_NAME [flags]
```

### Options

```
-h, --help help for get
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -166,18 +156,13 @@ Simply type config help [path to command] for full details.
minikube config help [command] [flags]
```

### Options

```
-h, --help help for help
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -205,18 +190,13 @@ Sets the PROPERTY_NAME config value to PROPERTY_VALUE
minikube config set PROPERTY_NAME PROPERTY_VALUE [flags]
```

### Options

```
-h, --help help for set
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand All @@ -243,18 +223,13 @@ unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags
minikube config unset PROPERTY_NAME [flags]
```

### Options

```
-h, --help help for unset
```

### Options inherited from parent commands

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down Expand Up @@ -286,7 +261,6 @@ minikube config view [flags]
```
--format string Go template format string for the config view output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}}\n")
-h, --help help for view
```

### Options inherited from parent commands
Expand All @@ -295,6 +269,7 @@ minikube config view [flags]
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
-h, --help
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
Expand Down
Loading

0 comments on commit 18b0c00

Please sign in to comment.