📖 Quickstart / add other sections

Signed-off-by: Vince Prignano <[email protected]>

Author: vincepri

README.md

@@ -12,7 +12,7 @@
 - [Scope, objectives, goals and requirements](./docs/scope-and-objectives.md)
 - [Feature proposals](./docs/proposals)
 - [Reference use cases](./docs/staging-use-cases.md)
-- [Quick Start](https://cluster-api.sigs.k8s.io/quick-start.html)
+- [Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html)
 
 ## What is the Cluster API?
 

docs/book/book.toml

@@ -8,3 +8,6 @@ title = "The Cluster API Book"
 [output.html]
 curly-quotes = true
 git-repository-url = "https://sigs.k8s.io/cluster-api"
+
+[preprocessor.foo]
+command = "go run -tags=tools ../../hack/tools/tabulate/tabulate.go"

docs/book/install-and-build.sh

@@ -60,4 +60,5 @@ curl -sL -o /tmp/mdbook.${ext} "https://github.com/rust-lang-nursery/mdBook/rele
 ${cmd} /tmp/mdbook.${ext}
 chmod +x /tmp/mdbook
 
-/tmp/mdbook build docs/book
+# Finally build the book.
+(cd docs/book && /tmp/mdbook build)

docs/book/src/SUMMARY.md

@@ -2,19 +2,21 @@
 
 [Introduction](./introduction.md)
 
-[Quick Start](./quick-start.md)
+- [User Guide](./user/guide.md)
+    - [Concepts](./user/concepts.md)
+    - [Quick Start](./user/quick-start.md)
 
-- [Architecture](./architecture/architecture.md)
+- [Developer Guide](./architecture/developer-guide.md)
     - [Repository Layout](./architecture/repository-layout.md)
     - [Controllers](./architecture/controllers.md)
         - [Cluster](./architecture/controllers/cluster.md)
         - [Machine](./architecture/controllers/machine.md)
         - [MachineSet](./architecture/controllers/machine-set.md)
         - [MachineDeployment](./architecture/controllers/machine-deployment.md)
-
-- [Clusterctl](./clusterctl/clusterctl.md)
-
-- [Provider Implementers](./providers/implementers.md)
+    - [Provider Implementers](./providers/implementers.md)
+        - [v1alpha1 to v1alpha2](./providers/v1alpha1-to-v1alpha2.md)
+    - [Tooling](./tooling/tooling.md)
+        - [Clusterctl](./tooling/clusterctl.md)
 
 - [Reference](./reference/reference.md)
     - [Abbreviations](./reference/abbreviations.md)

docs/book/src/architecture/architecture.md

@@ -0,0 +1 @@
+# Developer Guide

docs/book/src/architecture/developer-guide.md

@@ -1,7 +1,7 @@
 # The Cluster API Book <div style="float: right; position: relative; display: inline;"><img src="images/introduction.png" width="160px" /></div>
 
 **Note:** Impatient readers may head straight to [Quick
-Start](quick-start.md).
+Start](./user/quick-start.md).
 
 **Using Cluster API v1alpha1? Check the [legacy
 documentation](https://release-0-1.cluster-api.sigs.k8s.io)**
@@ -14,4 +14,4 @@ manage the lifecycle of a Kubernetes cluster.
 
 {{#include ../../scope-and-objectives.md:Goals}}
 
-{{#include ../../../README.md:Get Involved}}
+{{#include ../../../README.md:Community}}

docs/book/src/glossary.md

@@ -25,7 +25,6 @@ controllers that are responsible for the core types:
 * Machine
 * MachineSet
 * MachineDeployment
-* [plus a few more](../../pkg/apis/cluster/v1alpha2)
 
 Bootstrap providers are an entirely new concept aimed at reducing the amount of kubeadm boilerplate that every provider
 reimplemented in v1alpha1. The Bootstrap provider is responsible for running a controller that generates data necessary
@@ -41,7 +40,7 @@ bootstrap data to turn the infrastructure into a Kubernetes cluster.
 
 Actuators are interfaces that the Cluster API controller calls. A provider pulls in the generic Cluster API controller
 and then registers actuators to run specific infrastructure logic (calls to the provider cloud).
- 
+
 ### v1alpha2
 
 Actuators are not used in this version. Cluster API's controllers are no longer shared across providers and therefore
@@ -57,11 +56,11 @@ create a cloud instance for Kubernetes to run on.
 
 `clusterctl` was a command line tool packaged with v1alpha1 providers. The goal of this tool was to go from nothing to a
 running management cluster in whatever environment the provider was built for. For example, Cluster-API-Provider-AWS
-packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to 
+packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to
 Cluster API's APIs.
 
 ### v1alpha2
 
-`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused 
+`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused
 across providers. Work here is still being figured out but providers will not be packaging their own `clusterctl`
 anymore.