Add {README,CONTRIBUTING}.md

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
This commit is contained in:
Ahmet Alp Balkan 2017-03-29 00:30:12 -07:00
parent c849ef0083
commit 6de838135f
No known key found for this signature in database
GPG Key ID: 5C02521D7B216AD6
3 changed files with 57 additions and 1 deletions

23
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,23 @@
# How to contribute
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
## Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.
## Code reviews
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# kubectx(1)
kubectx is an utility to manage and switch between kubectl(1) contexts.
```
USAGE:
kubectx : list the contexts
kubectx <NAME> : switch to context
kubectx - : switch to the previous context
kubectx <NEW_NAME>=<NAME> : create alias for context
kubectx -h,--help : show this message
```
## Example
```
$ kubectx minikube
Switched to context "minikube".
$ kubectx -
Switched to context "oregon".
$ kubectx -
Switched to context "minikube".
$ kubectx dublin=gke_ahmetb_europe-west1-b_dublin
Context "dublin" set.
Aliased "gke_ahmetb_europe-west1-b_dublin" as "dublin".
```
-----
Disclaimer: This is not an official Google product.

View File

@ -123,7 +123,7 @@ alias_context() {
--cluster="${old_cluster}" \
--user="${old_user}" \
echo "Aliased ${old_name} as ${new_name}." >&2
echo "Aliased \"${old_name}\" as \"${new_name}\"." >&2
}
main() {