knative
/
client
mirror of https://github.com/knative/client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#1593) 

Clarify that kn plugins need `kn-` prefix to be picked up by kn. 
For example, the `func` plugin is only dected by kn if it is rename as `kn-func`
This commit is contained in:
Sameer Vohra 2022-02-01 04:52:31 -06:00 committed by GitHub
parent d2698c40a5
commit f28cd0e68a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
View File

@ -79,7 +79,7 @@ The following example contains a fully commented `config.yaml` with all availabl
plugins: plugins:
# Whether to lookup configuration in the execution path (default: true). This option is deprecated and will be removed in a future version where path lookup will be enabled unconditionally # Whether to lookup configuration in the execution path (default: true). This option is deprecated and will be removed in a future version where path lookup will be enabled unconditionally
path-lookup: true path-lookup: true
# Directory from where plugins are looked up. (default: "$base_dir/plugins" # Directory from where plugins with the prefix "kn-" are looked up. (default: "$base_dir/plugins"
# where "$base_dir" is the directory where this configuration file is stored) # where "$base_dir" is the directory where this configuration file is stored)
directory: ~/.config/kn/plugins directory: ~/.config/kn/plugins
# Eventing related configuration # Eventing related configuration
@ -115,7 +115,7 @@ You can specify the following options:
* `directory`, which is the same as the persistent flag `--plugins-dir` and specifies the kn plugins directory. It defaults to: `~/.config/kn/plugins`. * `directory`, which is the same as the persistent flag `--plugins-dir` and specifies the kn plugins directory. It defaults to: `~/.config/kn/plugins`.
By using the persistent flag (when you issue a command) or by specifying the By using the persistent flag (when you issue a command) or by specifying the
value in the `kn` config, a user can select which directory to find `kn` value in the `kn` config, a user can select which directory to find `kn`
plugins. It can be any directory that is visible to the user. plugins. It can be any directory that is visible to the user. The plugins need have a `kn-` prefix in their name (eg. `kn-quickstart`) to be detected by `kn`
* `path-lookup`, which is the same as the persistent flag * `path-lookup`, which is the same as the persistent flag
`--lookup-plugins-in-path` and specifies if `kn` should look for plugins anywhere in the specified `PATH` environment variable. This option is a boolean type, and the default value is `true`. This option is DEPRECATED and will be removed in a future version, when path lookup will be always enabled. `--lookup-plugins-in-path` and specifies if `kn` should look for plugins anywhere in the specified `PATH` environment variable. This option is a boolean type, and the default value is `true`. This option is DEPRECATED and will be removed in a future version, when path lookup will be always enabled.