Skip to content

Commit 55bab43

Browse files
committed
Replace embedded quick-start with link to upstream CAPI docs
Replace the embed-github preprocessor usage in getting-started.md with a direct link to the upstream Cluster API quick-start guide. This avoids the problem of embedded content becoming stale and removes the need for periodic rebuilds. Also removes the now-unused mdbook-embed preprocessor from book.toml and both Makefiles.
1 parent 0f0b378 commit 55bab43

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/book/Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ include $(ROOT_DIR_RELATIVE)/common.mk
1717

1818
# Directories.
1919
MDBOOK := $(TOOLS_BIN_DIR)/mdbook
20-
MDBOOK_EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
2120
MDBOOK_RELEASELINK := $(TOOLS_BIN_DIR)/mdbook-releaselink
2221
MDBOOK_TABULATE := $(TOOLS_BIN_DIR)/mdbook-tabulate
2322
BOOK_SRCS := $(call rwildcard,.,*.*)
@@ -38,11 +37,11 @@ verify: generate ## Verify that dependent artifacts are up to date
3837
fi
3938

4039
.PHONY: build
41-
build: $(BOOK_SRCS) $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Build the book
40+
build: $(BOOK_SRCS) $(MDBOOK) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Build the book
4241
$(MDBOOK) build
4342

4443
.PHONY: serve
45-
serve: $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Run a local webserver with the compiled book
44+
serve: $(MDBOOK) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Run a local webserver with the compiled book
4645
$(MDBOOK) serve
4746

4847
.PHONY: clean

docs/book/book.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,5 @@ git-repository-url = "https://sigs.k8s.io/cluster-api-provider-openstack"
1818
[preprocessor.tabulate]
1919
command = "mdbook-tabulate"
2020

21-
[preprocessor.embed]
22-
command = "mdbook-embed"
23-
2421
[preprocessor.releaselink]
2522
command = "mdbook-releaselink"

docs/book/src/getting-started.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,12 @@
88

99
# Getting Started
1010

11-
{{#embed-github repo:"kubernetes-sigs/cluster-api" path:"docs/book/src/user/quick-start.md"}}
11+
Please refer to the upstream Cluster API [Quick Start guide](https://cluster-api.sigs.k8s.io/user/quick-start) for instructions on how to set up a management cluster and create your first workload cluster.
12+
13+
The quick start guide covers:
14+
15+
- Installing prerequisites (`clusterctl`, `kind`, `kubectl`, etc.)
16+
- Creating a management cluster
17+
- Initializing infrastructure providers
18+
- Generating cluster configurations
19+
- Creating workload clusters

hack/tools/Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,6 @@ $(MDBOOK): $(MDBOOK_SHARE) | $(BIN_DIR)
139139
chmod +x $@
140140
touch -m $@
141141

142-
MDBOOK_EMBED := $(BIN_DIR)/mdbook-embed
143-
$(MDBOOK_EMBED): go.mod go.sum | $(BIN_DIR)
144-
go build -tags=tools -o $(BIN_DIR)/mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed
145-
146142
MDBOOK_RELEASELINK := $(BIN_DIR)/mdbook-releaselink
147143
$(MDBOOK_RELEASELINK): go.mod go.sum | $(BIN_DIR)
148144
go build -tags=tools -o $(BIN_DIR)/mdbook-releaselink sigs.k8s.io/cluster-api/hack/tools/mdbook/releaselink

0 commit comments

Comments
 (0)