chore: fixed documentation of configuration options in README #1297
Conversation
knative-prow-robot
added
the
size/L
|
|
||
| * `channel-type-mappings` can be used to define aliases for custom channel types that can be used wherever a channel type is required (as in `kn channel create --type`). This configuration section defines an array of entries with the following fields: |
There was a problem hiding this comment.
@abrennan89 this option is new and missing in the recent doc's PR. Please see also the full example above how this is used.
There was a problem hiding this comment.
Please open a doc issue for it an include the details 🙏🏻
There was a problem hiding this comment.
will do as soon as this is merged ...
docs/README.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # kn | |||
|
|
|||
| `kn` is the Knative command line interface (CLI). | |||
| `kn` is the Knative command-line interface (CLI). | |||
There was a problem hiding this comment.
This should just be "command line" please
docs/README.md
Outdated
| @@ -12,7 +12,7 @@ You can grab the latest nightly binary executable for: | |||
| - [Linux](https://storage.googleapis.com/knative-nightly/client/latest/kn-linux-amd64) | |||
| - [Windows](https://storage.googleapis.com/knative-nightly/client/latest/kn-windows-amd64.exe) | |||
|
|
|||
| Put it on your system path, and make sure it's executable. | |||
| Please put it on your system path, and make sure it's executable. | |||
There was a problem hiding this comment.
Don't add "please" in technical docs, this is actually called out in the Google developer style guide.
docs/README.md
Outdated
| @@ -12,7 +12,7 @@ You can grab the latest nightly binary executable for: | |||
| - [Linux](https://storage.googleapis.com/knative-nightly/client/latest/kn-linux-amd64) | |||
| - [Windows](https://storage.googleapis.com/knative-nightly/client/latest/kn-windows-amd64.exe) | |||
|
|
|||
| Put it on your system path, and make sure it's executable. | |||
| Please put it on your system path, and make sure it's executable. | |||
There was a problem hiding this comment.
| Please put it on your system path, and make sure it's executable. | |
| Add the binary to the system PATH and ensure that it is executable. |
docs/README.md
Outdated
| flag to specify its path. | ||
| You can customize your `kn` CLI setup by creating a `config.yaml` configuration file. You can either provide the configuration via a `--config` flag or is picked up from a default location. The default configuration location conforms to the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) and is different for Unix systems and Windows systems. If `XDG_CONFIG_HOME` env var is set, the default config location `kn` looks for is `$XDG_CONFIG_HOME/kn`, otherwise the file is looked up under the home directory of the user at `$HOME/.config/kn/config.yaml`. For Windows systems, the default `kn` configuration location is `%APPDATA%\kn`. | ||
|
|
||
| `kn` does not create a default configuration file, nor does it write into an existing configuration file. |
There was a problem hiding this comment.
Should we mention there that while we don’t create a default config, we do have defaults for everything in the config?
knative-prow-robot
added
the
do-not-merge/hold
knative-prow-robot
added
lgtm
|
/unhold @abrennan89 I addressed all comments, could I get a lgtm if ok ? |
knative-prow-robot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, maximilien The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
No description provided.