Add documentation for default index URI variable #669
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/M
|
I think this should go under User Guide directly, right after "Using Custom Plugin Indexes" which is currently the last page in there. We can call this "Advanced Configuration" to indicate most users should not be bothered by this page while reading the user guide. |
|
|
||
| ### Use a different default index | ||
|
|
||
| By default Krew uses [krew-index][ki] as the default plugin index. This is the |
There was a problem hiding this comment.
I'd rewrite this paragraph as follows:
When Krew is installed, it automatically initializes an index named
defaultpointing to [krew-index][ki] repository. If you choose to remove this index, see [custom indexes] documentation. You can also force Krew to point it to another repository by settingKREW_DEFAULT_INDEX_URI.
+mash that up with existing links + next paragraph you have.
There was a problem hiding this comment.
What about:
When Krew is installed, it automatically initializes an index named
default
pointing to the [krew-index][ki] repository. You can force Krew to use a
different repository by settingKREW_DEFAULT_INDEX_URIbefore running the
[installation instructions]({{<ref "install.md">}}) or after [removing the
default index]({{<ref "using-custom-indexes.md">}}).
To use a different default index, set the
KREW_DEFAULT_INDEX_URIenvironment
variable in your~/.bashrc,~/.bash_profile, or~/.zshrc:
I think it would make sense to keep the parts on when the env var needs to be set together instead of mentioning that you can set it after deleting the default index in the first paragraph and before krew installation in the second paragraph.
Also should I make this draft: true? IIRC the docs get published automatically.
There was a problem hiding this comment.
Don't worry about setting it as draft without a release being available. I highly suspect anyone’ll come looking for it.
I think your edit is good, make sure to mention this URI needs to point to a git repository reference (can be a real url, or another git-remote protocol like foo://bar/quux.git).
There was a problem hiding this comment.
Made the change, @ahmetb mind taking another look?
k8s-ci-robot
added
size/S
| @@ -0,0 +1,38 @@ | |||
| --- | |||
| title: Configuration | |||
There was a problem hiding this comment.
Maybe talk about customization?
| export KREW_NO_UPGRADE_CHECK=1 | ||
| ``` | ||
|
|
||
| ### Use a different default index |
There was a problem hiding this comment.
| ### Use a different default index | |
| ### Use a custom default index |
| ### Use a different default index | ||
|
|
||
| By default Krew uses [krew-index][ki] as the default plugin index. This is the | ||
| repository that is normally used for plugin discovery. However, you can use a |
There was a problem hiding this comment.
| repository that is normally used for plugin discovery. However, you can use a | |
| This index contains a curated list of plugins. However, you can use a |
k8s-ci-robot
added
the
lgtm
|
@corneliusweig I think your review comments were on an older version of this PR |
|
Yes indeed. Epic fail with GitHub app for mobile :-S |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chriskim06, corneliusweig 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 |
k8s-ci-robot
added
the
approved
So I wasn't super sure where this should go. After looking around I was thinking about either adding it as a separate page under the
setup/tree or consolidating this with the update check doc. I landed on consolidating the two but let me know what you guys think.Fixes #637
/assign @ahmetb
/assign @corneliusweig