Added toc to md for better readability. (openshift#313)

CONTRIBUTING.md

@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Contributing guidelines](#contributing-guidelines)
+  - [Sign the CLA](#sign-the-cla)
+    - [Contributing A Patch](#contributing-a-patch)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Contributing guidelines
 
 ## Sign the CLA

README.md

@@ -1,3 +1,21 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Kubernetes cluster-api-provider-openstack Project](#kubernetes-cluster-api-provider-openstack-project)
+  - [Community, discussion, contribution, and support](#community-discussion-contribution-and-support)
+    - [Code of conduct](#code-of-conduct)
+  - [Compatibility with Cluster API, Kubernetes and OpenStack Versions](#compatibility-with-cluster-api-kubernetes-and-openstack-versions)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Cluster Creation](#cluster-creation)
+    - [Managed OpenStack Security Groups](#managed-openstack-security-groups)
+    - [Interacting with your cluster](#interacting-with-your-cluster)
+    - [Cluster Deletion](#cluster-deletion)
+    - [Trouble shooting](#trouble-shooting)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Kubernetes cluster-api-provider-openstack Project
 
 This repository hosts a concrete implementation of an OpenStack provider for the [cluster-api project](https://github.com/kubernetes-sigs/cluster-api).

cmd/clusterctl/examples/openstack/README.md

@@ -1,3 +1,15 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Openstack Example Files](#openstack-example-files)
+  - [Contents](#contents)
+  - [Prerequisites](#prerequisites)
+  - [Generation](#generation)
+  - [Manual Modification](#manual-modification)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Openstack Example Files
 ## Contents
 - `*.yaml` - concrete example files that can be used as is.

code-of-conduct.md

@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Kubernetes Community Code of Conduct](#kubernetes-community-code-of-conduct)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Kubernetes Community Code of Conduct
 
 Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md)

docs/config.md

@@ -1,3 +1,26 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Required Configuration](#required-configuration)
+  - [Machines YAML](#machines-yaml)
+  - [Private Network](#private-network)
+  - [Public Network](#public-network)
+  - [Floating IP](#floating-ip)
+  - [Proper Routing](#proper-routing)
+  - [Security Group Rules](#security-group-rules)
+  - [Security Groups](#security-groups)
+  - [Operating System Images](#operating-system-images)
+  - [Subnets](#subnets)
+  - [Network Filters](#network-filters)
+  - [Multiple Networks](#multiple-networks)
+  - [Tagging](#tagging)
+  - [Metadata](#metadata)
+- [Optional Configuration](#optional-configuration)
+  - [Boot From Volume](#boot-from-volume)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Required Configuration
 
 To succesfully run a kubernetes cluster in openstack, you will need to configure a few essential properties, then ensure that they are added to your machines.yaml file. The following components are necessary:

docs/trouble_shooting.md

@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Trouble shooting](#trouble-shooting)
+  - [Get log of clusterapi-controllers containers](#get-log-of-clusterapi-controllers-containers)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Trouble shooting
 
 This guide (based on minikube and others should be similar) explains general info on how to debug issues if cluster failed to create.