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

Merge pull request #2931 from mrtyler/doc_fixes 

Doc fixes
This commit is contained in:
Chris Love 2017-07-14 12:25:44 -06:00 committed by GitHub
parent 9439077bdf f856fddff4
commit 39ef6433a2
3 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -92,10 +92,10 @@ What this means:
__Issues__ __Issues__
* Help read and triage issues, assist when possible. * Help read and triage issues, assist when possible.
* Point out issues that are duplicates, out of date, etc. * Point out issues that are duplicates, out of date, etc.
- Even if you don't have tagging permissions, make a note and tag maintainers. (`/close`,`/dupe #127`) - Even if you don't have tagging permissions, make a note and tag maintainers (`/close`,`/dupe #127`).
__Pull Requests__ __Pull Requests__
* Read and review the code. Leave comments, questions, and critiques (`/lgtm` ) * Read and review the code. Leave comments, questions, and critiques (`/lgtm` ).
* Download, compile, and run the code and make sure the tests pass (make test). * Download, compile, and run the code and make sure the tests pass (make test).
- Also verify that the new feature seems sane, follows best architectural patterns, and includes tests. - Also verify that the new feature seems sane, follows best architectural patterns, and includes tests.
@ -136,7 +136,7 @@ You can check your week number using:
date +%V date +%V
``` ```
The maintainers and other community members are generally available on the [kubernetes slack](https://github.com/kubernetes/community#slack-chat) in [#kops](https://kubernetes.slack.com/messages/kops/), so come find and chat with us about how kops can be better for you! The maintainers and other community members are generally available on the [kubernetes slack](https://github.com/kubernetes/community/blob/master/communication.md#social-media) in [#kops](https://kubernetes.slack.com/messages/kops/), so come find and chat with us about how kops can be better for you!
## GitHub Issues ## GitHub Issues
@ -147,17 +147,17 @@ If you think you have found a bug please follow the instructions below.
- Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. - Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate.
- Set `-v 10` command line option and save the log output. Please paste this into your issue. - Set `-v 10` command line option and save the log output. Please paste this into your issue.
- Note the version of kops you are running (from `kops version`), and the command line options you are using - Note the version of kops you are running (from `kops version`), and the command line options you are using.
- Open a [new issue](https://github.com/kubernetes/kops/issues/new) - Open a [new issue](https://github.com/kubernetes/kops/issues/new).
- Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others. - Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others.
- Feel free to reach out to the kops community on [kubernetes slack](https://github.com/kubernetes/community#slack-chat) - Feel free to reach out to the kops community on [kubernetes slack](https://github.com/kubernetes/community/blob/master/communication.md#social-media).
### Features ### Features
We also use the issue tracker to track features. If you have an idea for a feature, or think you can help kops become even more awesome follow the steps below. We also use the issue tracker to track features. If you have an idea for a feature, or think you can help kops become even more awesome follow the steps below.
- Open a [new issue](https://github.com/kubernetes/kops/issues/new) - Open a [new issue](https://github.com/kubernetes/kops/issues/new).
- Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others. - Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others.
- Clearly define the use case, using concrete examples. EG: I type `this` and kops does `that`. - Clearly define the use case, using concrete examples. EG: I type `this` and kops does `that`.
- Some of our larger features will require some design. If you would like to include a technical design for your feature please include it in the issue. - Some of our larger features will require some design. If you would like to include a technical design for your feature please include it in the issue.

2
docs/README.md
View File

@ -103,7 +103,7 @@
* [Example on how to add a feature](development/adding_a_feature.md) * [Example on how to add a feature](development/adding_a_feature.md)
* [Hack Directory](development/hack.md) * [Hack Directory](development/hack.md)
* [How to update `kops` API](development/api_updates.md) * [How to update `kops` API](development/api_updates.md)
* [Low level description on how kops works](how_it_works.md) * [Low level description on how kops works](development/how_it_works.md)
* [Notes on Gossip design](development/gossip.md) * [Notes on Gossip design](development/gossip.md)
* [Notes on master instance sizing](development/instancesizes.md) * [Notes on master instance sizing](development/instancesizes.md)
* [Our release process](development/release.md) * [Our release process](development/release.md)

13
docs/manifests_and_customizing_via_api.md
View File

@ -327,19 +327,18 @@ metadata:
spec: spec:
``` ```
Full documentation is accessible via [godocs] (https://godoc.org/k8s.io/kops/pkg/apis/kops#InstanceGroupSpec). Full documentation is accessible via [godocs](https://godoc.org/k8s.io/kops/pkg/apis/kops#InstanceGroupSpec).
Instance Groups map to auto scale groups in AWS, and Instance Groups in GCE. They are an API level description of a group of compute instances used as Masters or Nodes. Instance Groups map to Auto Scaling Groups in AWS, and Instance Groups in GCE. They are an API level description of a group of compute instances used as Masters or Nodes.
More documentation is available in the [Instance Group](instance_groups.md) document. More documentation is available in the [Instance Group](instance_groups.md) document.
## Closing Thoughts ## Closing Thoughts
Using YAML or JSON-based configuration for building and managing kops clusters is powerful, but use with caution. Using YAML or JSON-based configuration for building and managing kops clusters is powerful, but use this strategy with caution.
- If you do not need to define or customize a value, let kops set that value - If you do not need to define or customize a value, let kops set that value. Setting too many values prevents kops from doing its job in setting up the cluster and you may end up with strange bugs.
Setting too many values dont allow kops to do its job in setting up the cluster and you may end up with strange bugs - If you end up with strange bugs, try letting kops do more.
- If you end up with strange bugs, try letting kops do more
- Be cautious, take care, and test test test outside of production! - Be cautious, take care, and test test test outside of production!
If you need to run a custom version of Kubernetes Controller Manager, set `kubeControllerManager.image` and update your cluster, and that is the beauty of using a manifest for your cluster. If you need to run a custom version of Kubernetes Controller Manager, set `kubeControllerManager.image` and update your cluster. This is the beauty of using a manifest for your cluster!