added documentation index

I added a README.md in the /docs directory which should help make the
docs more discoverable, and I added a reference to this index on the
main README.md. I also renamed 'tips.md' to 'kubectl.md' and changed
to title, to better reflect its content.

README.md

@@ -8,12 +8,14 @@
 
 The easiest way to get a production grade Kubernetes cluster up and running.
 
+
 ## What is kops?
 
 We like to think of it as `kubectl` for clusters.
 
 `kops` helps you create, destroy, upgrade and maintain production-grade, highly available, Kubernetes clusters from the command line.  AWS (Amazon Web Services) is currently officially supported, with GCE and VMware vSphere in alpha and other platforms planned.
 
+
 ## Can I see it in action?
 
 <p align="center">
@@ -27,6 +29,7 @@ We like to think of it as `kubectl` for clusters.
 To replicate the above demo, check out our [tutorial](/docs/aws.md) for
 launching a Kubernetes cluster hosted on AWS.
 
+
 ## Features
 
 * Automates the provisioning of Kubernetes clusters in ([AWS](/docs/aws.md))
@@ -38,14 +41,22 @@ launching a Kubernetes cluster hosted on AWS.
 * Command line [autocompletion](/docs/cli/kops_completion.md)
 * Community supported!
 
+
+## Documentations
+
+Documentation is in the `/docs` directory, [and the index is here.](docs/README.md)
+
+
 ## Installing
 
 `kubectl` is required, see [here](http://kubernetes.io/docs/user-guide/prereqs/).
 
+
 ### OSX From Homebrew (Latest Stable Release)
 
 ```console
 $ brew update && brew install kops
+
 ```
 ### Linux
 
@@ -56,8 +67,8 @@ $ chmod +x kops-linux-amd64                 # Add execution permissions
 $ mv kops-linux-amd64 /usr/local/bin/kops   # Move the kops to /usr/local/bin
 ```
 
-### Developer From Source
 
+### Developer From Source
 
 Go 1.8+ and make are required. You may need to do a full build including pushing protokube, nodeup, and kops to s3.
 
@@ -72,11 +83,13 @@ $ make
 
 At this time, Windows is not a supported platform.
 
+
 ## History
 
 See the [releases](https://github.com/kubernetes/kops/releases) for more
 information on changes between releases.
 
+
 ## Getting involved and contributing!
 
 Are you interested in contributing to kops? We, the maintainers and community, would love your suggestions, contributions, and help! We have a quick-start guide on [adding a feature](/docs/development/adding_a_feature.md).  Also, the maintainers can be contacted at any time to learn more about how to get involved.
@@ -108,10 +121,12 @@ __Pull Requests__
 * [@geojaz](https://github.com/geojaz)
 * [@yissachar](https://github.com/yissachar)
 
+
 ## Office Hours
 
 Kops maintainers set aside one hour every other week for **public** office hours. Office hours are hosted on a [zoom video chat](https://zoom.us/my/k8ssigaws) on Fridays at [5 pm UTC/12 noon ET/9 am US Pacific](http://www.worldtimebuddy.com/?pl=1&lid=100,5,8,12), on odd week numbered weeks.  We strive to get to know and help developers either working on `kops` or interested in getting to know more about the project.
 
+
 ### Open Office Hours Topics
 
 Include but not limited to:
@@ -146,6 +161,7 @@ The maintainers and other community members are generally available on the [kube
  - Look at our [other interesting modes](/docs/commands.md#other-interesting-modes)
  - Full command line interface [documentation](/docs/cli/kops.md)
 
+
 ## GitHub Issues
 
 #### Bugs
@@ -159,6 +175,7 @@ If you think you have found a bug please follow the instructions below.
 - 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)
 
+
 #### 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.

docs/README.md

@@ -0,0 +1,97 @@
+Documentation Index
+===================
+
+This page serves as a categorized index for all `kops` documentation.
+
+
+Quick start
+-----------
+* [Getting started on AWS](aws.md)
+* [CLI reference](cli/kops.md)
+
+
+Overview
+--------
+
+* [CLI](#cli)
+* [Introspection](#introspection)
+* [`kops` design documents](#kops-design-documents)
+* [Networking](#networking)
+* [Operations](#operations)
+* [Security](#security)
+* [Workflows](#workflows)
+
+
+
+### CLI ###
+
+* [CLI argument explanations](arguments.md)
+* [CLI reference](cli/kops.md)
+* [Commands](commands.md)
+    * miscellaneous CLI-related remarks
+* [Experimental features](experimental.md)
+    * list of and how to enable experimental flags in the CLI
+* [kubectl](kubectl.md)
+    * how to point kubectl to your `kops` cluster
+
+
+### Introspection ###
+
+* [Download `kops` configuration](download_config.md)
+    * methods to download the current generated `kops` configuration
+* [Get AWS subdomain NS records](ns.md)
+
+
+### `kops` design documents ###
+
+* [`kops` cluster boot sequence](boot-sequence.md)
+* [`kops` cluster spec](cluster_spec.md)
+* [`kops` instance groups](instance_groups.md)
+* [`kops` philosophy](philosophy.md)
+* [`kops` state store](state.md)
+
+
+### Networking ###
+
+* [Networking overview](networking.md)
+* [Run `kops` in an existing VPC](run_in_existing_vpc.md)
+* [Supported network topologies](topology.md)
+* [Subdomain setup](creating_subdomain.md)
+
+
+### Operations ###
+
+* [Cluster addon manager](addon_manager.md)
+* [Cluster addons](addons.md)
+* [Cluster configuration management](changing_configuration.md)
+* [Cluster with HA creation example](advanced_create.md)
+* [Cluster upgrades and migrations](cluster_upgrades_and_migrations.md)
+* [`etcd` volume encryption setup](etcd_volume_encryption.md)
+* [`etcd` backup setup](etcd_backup.md)
+* [GPU setup](gpu.md)
+* [High Availability](high_availability.md)
+* [InstanceGroup images](images.md)
+    * how to modify IG images and information on available/tested images
+* [Label management](labels.md)
+    * for AWS instance tags and `k8s` node labels
+* [`kube-up` to `kops` migration](upgrade_from_kubeup.md)
+* [Secret management](secrets.md)
+* [Single-master to multi-master migration](single-to-multi-master.md)
+* [`k8s` updating](upgrade.md)
+* [`kops` updating](update_kops.md)
+
+
+### Security ###
+
+* [Bastion setup](bastion.md)
+* [IAM roles](iam_roles.md)
+* [MFA setup](mfa.md)
+    * how to set up MFA for `kops`
+* [Security](security.md)
+    * overview of secret storage, SSH credentials etc.
+
+
+### Workflows ###
+
+* [E2E testing with `kops` clusters](testing.md)
+* [Getting started on AWS](aws.md)

docs/tips.md → docs/kubectl.md

@@ -1,4 +1,4 @@
-# Tips and Tricks
+# kubectl
 
 ## Create kubecfg settings for kubectl
 
@@ -16,4 +16,4 @@ ${GOPATH}/bin/kops export kubecfg ${NAME}
 
 You can now use kubernetes using the kubectl tool (after allowing a few minutes for the cluster to come up):
 
-```kubectl get nodes```
+```kubectl get nodes```