build book

Signed-off-by: jichenjc <[email protected]>

Author: jichenjc

README.md

@@ -37,12 +37,11 @@ previous cluster managers such as [kops][kops] and
 
 This provider's versions are compatible with the following versions of Cluster API:
 
-| | Cluster API v1alpha1 (v0.1) | Cluster API v1alpha2 (v0.2) | Cluster API v1alpha3 (v0.3) |  Cluster API v1alpha4 (v0.4) |
+| | Cluster API v1alpha1 (v0.1) | Cluster API v1alpha2 (v0.2) | Cluster API v1alpha3 (v0.3) |
 |-------------------------------------------------|---|---|---|---|
 | OpenStack Provider v1alpha1 (release-0.1 branch)| ✓ |   |   |   |
 | OpenStack Provider v1alpha2 (v0.2)              |   | ✓ |   |   |
 | OpenStack Provider v1alpha3 (v0.3)              |   |   | ✓ |   |
-| OpenStack Provider v1alpha4 (v0.4)              |   |   |   | ✓ |
 
 This provider's versions are able to install and manage the following versions of Kubernetes:
 
@@ -83,7 +82,7 @@ Reference images can be found in [kubernetes-sigs/image-builder](https://github.
 
 ## Documentation
 
-Documentation can be found in the `/docs` directory
+Documentation can be found in the `/docs/src` directory
 
 ## Getting involved and contributing
 

docs/Makefile

@@ -0,0 +1,25 @@
+# Copyright 2018 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.
+
+# If you update this file, please follow
+# https://suva.sh/posts/well-documented-makefiles
+
+ROOT_DIR_RELATIVE := ..
+include $(ROOT_DIR_RELATIVE)/common.mk
+
+DIAGRAM_SRCS := $(call rwildcard,.,*.md,*.plantuml)
+
+diagrams: $(TOOLS_BIN_DIR)/plantuml-sentinal ## Generate plantuml diagrams
+	-docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder -tsvg /docs/**/*.md
+	-docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder -tsvg /docs/**/*.plantuml

docs/book/.gitignore

@@ -0,0 +1,2 @@
+# book file
+book

docs/book/Makefile

@@ -0,0 +1,50 @@
+# Copyright 2020 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.
+
+ROOT_DIR_RELATIVE := ../..
+include $(ROOT_DIR_RELATIVE)/common.mk
+
+# Directories.
+MDBOOK := $(TOOLS_BIN_DIR)/mdbook
+MDBOOK_EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
+MDBOOK_RELEASELINK := $(TOOLS_BIN_DIR)/mdbook-releaselink
+MDBOOK_TABULATE := $(TOOLS_BIN_DIR)/mdbook-tabulate
+BOOK_SRCS :=  $(call rwildcard,.,*.*)
+
+OS := $(shell go env GOOS)
+ARCH := $(shell go env GOARCH)
+PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
+export PATH
+
+.PHONY: generate
+generate: ## Generate any dependent files outside of a build
+	$(MAKE) -C ../ diagrams
+
+verify: generate ## Verify that dependent artifacts are up to date
+	@if !(git diff --quiet HEAD); then \
+		git diff; \
+		echo "generated files are out of date, run make generate"; exit 1; \
+	fi
+
+.PHONY: build
+build: $(BOOK_SRCS) $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Build the book
+	$(MDBOOK) build
+
+.PHONY: serve
+serve: $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Run a local webserver with the compiled book
+	$(MDBOOK) serve
+
+.PHONY: clean
+clean:
+	rm -rf book

docs/book/book.toml

@@ -0,0 +1,19 @@
+[book]
+authors = ["The Cluster API Provider OpenStack Maintainers"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Kubernetes Cluster API Provider OpenStack"
+
+[output.html]
+curly-quotes = true
+git-repository-url = "https://sigs.k8s.io/cluster-api-provider-openstack"
+
+[preprocessor.tabulate]
+command = "mdbook-tabulate"
+
+[preprocessor.embed]
+command = "mdbook-embed"
+
+[preprocessor.releaselink]
+command = "mdbook-releaselink"

docs/book/src/SUMMARY.md

@@ -0,0 +1,9 @@
+# Summary
+
+- [Introduction](./introduction.md)
+- [Getting Started](getting-started.md)
+- [Configuration](clusteropenstack/configuration.md)
+- [Topics](./topics/index.md)
+    - [external cloud provider](./topics/external-cloud-provider.md)
+    - [move from bootstrap](./topics/mover.md)
+    - [trouble shooting](./topics/troubleshooting.md)