📖 Quickstart / add other sections

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

Author: vincepri

Makefile

@@ -280,4 +280,4 @@ diagrams: ## Build proposal diagrams
 
 .PHONY: serve-book
 serve-book: ## Build and serve the book with live-reloading enabled
-	(cd ./docs/book && mdbook serve)
+	$(MAKE) -C docs/book serve

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/Makefile

@@ -17,6 +17,7 @@ ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 SOURCES := $(shell find ${ROOT_DIR} -name \*.plantuml)
 DIAGRAMS := $(SOURCES:%.plantuml=%.png)
 
+.PHONY: diagrams
 diagrams: $(DIAGRAMS)
 
 %.png: %.plantuml
@@ -26,5 +27,3 @@ diagrams: $(DIAGRAMS)
 		--user $(shell id -u):$(shell id -g) \
 		us.gcr.io/k8s-artifacts-prod/cluster-api/plantuml:1.2019.6 \
 		-v /workdir/$(shell echo '$^' | sed -e 's,.*docs/,,g' )
-
-.PHONY: diagrams

docs/book/Makefile

@@ -0,0 +1,29 @@
+# Copyright 2019 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Directories.
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+TOOLS_DIR := ../../hack/tools
+TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
+BIN_DIR := bin
+
+# Binaries.
+TABULATE := $(TOOLS_BIN_DIR)/tabulate
+
+$(TABULATE): $(TOOLS_DIR)/go.mod
+	cd $(TOOLS_DIR); go build -tags=tools -o $(BIN_DIR)/tabulate ./tabulate
+
+.PHONY: serve
+serve:
+	mdbook serve

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 = "./tabulate.sh"

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