Book initial version

docs/book/Makefile

@@ -0,0 +1,43 @@
+# Copyright 2024 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 := $(realpath ../../hack/tools)
+TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
+BIN_DIR := bin
+MDBOOK_INSTALL := $(realpath ../../scripts/ci-install-mdbook.sh)
+TABULATE := $(TOOLS_BIN_DIR)/mdbook-tabulate
+EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
+RELEASELINK := $(TOOLS_BIN_DIR)/mdbook-releaselink
+MDBOOK := $(TOOLS_BIN_DIR)/mdbook
+
+export PATH := $(TOOLS_BIN_DIR):$(PATH)
+
+BOOK_DEPS := $(MDBOOK) $(TABULATE) $(EMBED) $(RELEASELINK)
+
+$(TOOLS_BIN_DIR)/%: $(TOOLS_DIR_DEPS)
+	make -C $(TOOLS_DIR) $(subst $(TOOLS_DIR)/,,$@)
+
+.PHONY: serve
+serve: $(BOOK_DEPS) ## Run a local web server with the compiled book
+	$(MDBOOK) serve
+
+.PHONY: build
+build: $(BOOK_DEPS) ## Build the book
+	$(MDBOOK) build
+
+.PHONY: clean
+clean:
+	rm -rf book

docs/book/book.toml

@@ -0,0 +1,24 @@
+[book]
+authors = ["The Cluster API Provider GCP Maintainers"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Kubernetes Cluster API Provider GCP"
+
+[output.html]
+curly-quotes = true
+git-repository-url = "https://sigs.k8s.io/cluster-api-provider-gcp"
+no-section-label = true
+
+[output.html.redirect]
+"/agenda.html" = "/agenda/2024.html"
+"/agenda/2024.html" = "https://docs.google.com/document/d/1l8B947Je79ZJX7zmKnJyMcOMIWjNidvp5FMTnPAY72I/"
+
+[preprocessor.tabulate]
+command = "mdbook-tabulate"
+
+[preprocessor.embed]
+command = "mdbook-embed"
+
+[preprocessor.releaselink]
+command = "mdbook-releaselink"

docs/book/src/SUMMARY.md

@@ -0,0 +1,21 @@
+# Summary
+
+[Introduction](./introduction.md)
+- [Getting Started](./getting-started.md)
+- [Topics](./topics/index.md)
+    - [Prerequisites](./topics/prerequisites.md)
+    - [Conformance](./topics/conformance.md)
+    - [GKE Support](./topics/gke/index.md)
+        - [Creating a Cluster](./topics/gke/creating-a-cluster.md)
+        - [Cluster Upgrades](./topics/gke/cluster-upgrades.md)
+        - [Enabling](./topics/gke/enabling.md)
+        - [Disabling](./topics/gke/disabling.md)
+    - [Machine Locations](./topics/machine-locations.md)
+    - [Preemptible VMs](./topics/preemptible-vms.md)
+    - [Flannel](./topics/flannel.md)
+- [Developer Guide](./developers/index.md)
+    - [Development](./developers/development.md)
+    - [Creating a cluster](./developers/cluster-creation.md)
+    - [CI Jobs](./developers/jobs.md)
+    - [Releasing](./developers/releasing.md)
+- [Roadmap](./roadmap.md)

docs/book/src/developers/index.md

@@ -0,0 +1,3 @@
+Everything you need to know about contributing to CAPG.
+
+If you are new to the project and want to help but don't know where to start, you can refer to the [Cluster API contributing guide](https://github.com/kubernetes-sigs/cluster-api/blob/main/CONTRIBUTING.md).

docs/book/src/getting-started.md

@@ -0,0 +1 @@
+{{#embed-github repo:"kubernetes-sigs/cluster-api" path:"docs/book/src/user/quick-start.md"}}

docs/book/src/introduction.md

@@ -0,0 +1 @@
+{{#include ../../../README.md}}

docs/book/src/topics/index.md

@@ -0,0 +1 @@
+This section contains information about the main CAPG features and how to use them.