forked from kubernetes-sigs/krew-index
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Redirect plugins list (kubernetes-sigs#882)
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
- Loading branch information
Showing
2 changed files
with
26 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,51 @@ | ||
# krew-index | ||
|
||
This is the centralized plugin index for [krew kubectl plugin manager][krew]. | ||
This repository is the centralized plugin index for [Krew (kubectl plugin | ||
manager)][krew-site]. It is meant to be useful only for plugin developers. | ||
|
||
* As a kubectl user: Through [krew][krew], you can discover available kubectl | ||
plugins hosted in this repository. | ||
* As a kubectl plugin developer: You can publish your plugins in this | ||
repository and make it available to others. | ||
- **If you are a Krew user:** You can find the list of kubectl plugins at the | ||
[Krew website](http://krew.sigs.k8s.io/plugins). | ||
|
||
[krew]: https://github.com/kubernetes-sigs/krew | ||
- **If you are a kubectl plugin developer:** Read the [Developer | ||
Guide][dev-guide] to learn how to package and publish a plugin in this | ||
repository. | ||
|
||
## Available kubectl plugins | ||
|
||
[See this list](./plugins.md) or the [`./plugins` directory](./plugins) | ||
directory. You can also install [krew][krew] and list available plugins with: | ||
|
||
kubectl krew search | ||
[krew-site]: https://krew.sigs.k8s.io/ | ||
[krew-repo]: http://sigs.k8s.io/krew | ||
[dev-guide]: https://krew.sigs.k8s.io/docs/developer-guide/ | ||
|
||
## Submitting new plugins | ||
|
||
To learn how to create a new plugin and submit it to krew-index, read the | ||
[Developer Guide](https://krew.sigs.k8s.io/docs/developer-guide/) | ||
and make a pull request to this repository. | ||
To learn how to create a new plugin and submit it to `krew-index`, read the | ||
[Developer Guide][dev-guide] and make a | ||
pull request to this repository. | ||
|
||
The decision criteria for plugins accepted to the centralized repository are | ||
evaluated on a case-by-case basis as the community arrives to a decision on | ||
the admission criteria for this repository. | ||
|
||
## Documentation | ||
|
||
- [Architecture](https://github.com/kubernetes-sigs/krew/blob/master/docs/KREW_ARCHITECTURE.md) | ||
- [Docs](https://github.com/kubernetes-sigs/krew/blob/master/docs/) | ||
- [Contributing](./CONTRIBUTING.md) | ||
If your plugin is rejected from this repository, you can host your own [custom | ||
index](https://krew.sigs.k8s.io/docs/developer-guide/custom-indexes/) repository | ||
to distribute your plugin with Krew. | ||
|
||
## Community | ||
|
||
### Bug reports | ||
|
||
* If you're having a problem with a particular plugin's installation or | ||
upgrades, file an issue in this repository. | ||
* If you have a problem with the Krew itself, please file an | ||
issue in the [krew] repository. | ||
* If you're having an issue with an installed plugin, file an issue for the | ||
repository the plugin's source code is hosted at. | ||
- If you're having an issue with an installed **plugin itself**, file an issue | ||
for the repository the plugin's source code is hosted at. | ||
- If you're having a problem **installing or upgrading a plugin**, file an issue | ||
in this repository. | ||
- If you have a problem with the **Krew itself**, please file an issue in the | ||
[krew][krew-repo] repository. | ||
|
||
### Communication channels | ||
|
||
* [Slack](https://kubernetes.slack.com/messages/krew) #krew | ||
* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-cli) | ||
* [Kubernetes Community site](http://kubernetes.io/community/) | ||
- [Slack](https://kubernetes.slack.com/messages/krew) #krew | ||
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-cli) | ||
- [Kubernetes Community site](http://kubernetes.io/community/) | ||
|
||
### Code of Conduct | ||
|
||
Participation in the Kubernetes community is governed by the [Kubernetes Code | ||
of Conduct](https://github.com/kubernetes-sigs/kustomize/blob/master/code-of-conduct.md). | ||
|
||
[index]:https://github.com/kubernetes-sigs/krew-index |
Oops, something went wrong.