Skip to content

Commit 1b6a8eb

Browse files
jichenjcjichenjc
committed
build book
Signed-off-by: jichenjc <[email protected]>
1 parent 0d0ed4e commit 1b6a8eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+12219
-7
lines changed

‎docs/Makefile

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Copyright 2018 The Kubernetes Authors.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# If you update this file, please follow
16+
# https://suva.sh/posts/well-documented-makefiles
17+
18+
ROOT_DIR_RELATIVE := ..
19+
include $(ROOT_DIR_RELATIVE)/common.mk
20+
21+
DIAGRAM_SRCS := $(call rwildcard,.,*.md,*.plantuml)
22+
23+
diagrams: $(TOOLS_BIN_DIR)/plantuml-sentinal ## Generate plantuml diagrams
24+
-docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder -tsvg /docs/**/*.md
25+
-docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder -tsvg /docs/**/*.plantuml

‎docs/book/Makefile

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Copyright 2020 The Kubernetes Authors.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
ROOT_DIR_RELATIVE := ../..
16+
include $(ROOT_DIR_RELATIVE)/common.mk
17+
18+
# Directories.
19+
MDBOOK := $(TOOLS_BIN_DIR)/mdbook
20+
MDBOOK_EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
21+
MDBOOK_RELEASELINK := $(TOOLS_BIN_DIR)/mdbook-releaselink
22+
MDBOOK_TABULATE := $(TOOLS_BIN_DIR)/mdbook-tabulate
23+
BOOK_SRCS := $(call rwildcard,.,*.*)
24+
25+
OS := $(shell go env GOOS)
26+
ARCH := $(shell go env GOARCH)
27+
PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
28+
export PATH
29+
30+
.PHONY: generate
31+
generate: ## Generate any dependent files outside of a build
32+
$(MAKE) -C ../ diagrams
33+
34+
verify: generate ## Verify that dependent artifacts are up to date
35+
@if !(git diff --quiet HEAD); then \
36+
git diff; \
37+
echo "generated files are out of date, run make generate"; exit 1; \
38+
fi
39+
40+
.PHONY: build
41+
build: $(BOOK_SRCS) $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Build the book
42+
$(MDBOOK) build
43+
44+
.PHONY: serve
45+
serve: $(MDBOOK) $(MDBOOK_EMBED) $(MDBOOK_RELEASELINK) $(MDBOOK_TABULATE) ## Run a local webserver with the compiled book
46+
$(MDBOOK) serve
47+
48+
.PHONY: clean
49+
clean:
50+
rm -rf book

‎docs/book/book.toml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[book]
2+
authors = ["The Cluster API Provider Openstack Maintainers"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Kubernetes Cluster API Provider Openstack"
7+
8+
[output.html]
9+
curly-quotes = true
10+
git-repository-url = "https://sigs.k8s.io/cluster-api-provider-openstack"
11+
12+
[preprocessor.tabulate]
13+
command = "mdbook-tabulate"
14+
15+
[preprocessor.embed]
16+
command = "mdbook-embed"
17+
18+
[preprocessor.releaselink]
19+
command = "mdbook-releaselink"

‎docs/book/book/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file makes sure that Github Pages doesn't process mdBook's output.

‎docs/book/book/404.html

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="sidebar-visible no-js light">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title></title>
7+
8+
9+
<base href="/">
10+
11+
12+
13+
<!-- Custom HTML head -->
14+
<link
15+
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:ital,wght@0,400;0,700;1,400;1,700&family=Lato:ital,wght@0,400;0,700;1,400;1,700&display=swap"
16+
rel="stylesheet">
17+
18+
19+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
20+
<meta name="description" content="">
21+
<meta name="viewport" content="width=device-width, initial-scale=1">
22+
<meta name="theme-color" content="#ffffff" />
23+
24+
25+
26+
<link rel="shortcut icon" href="favicon.png">
27+
28+
<link rel="stylesheet" href="css/variables.css">
29+
<link rel="stylesheet" href="css/general.css">
30+
<link rel="stylesheet" href="css/chrome.css">
31+
32+
<link rel="stylesheet" href="css/print.css" media="print">
33+
34+
35+
<!-- Fonts -->
36+
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
37+
38+
<link rel="stylesheet" href="fonts/fonts.css">
39+
40+
41+
<!-- Highlight.js Stylesheets -->
42+
<link rel="stylesheet" href="highlight.css">
43+
<link rel="stylesheet" href="tomorrow-night.css">
44+
<link rel="stylesheet" href="ayu-highlight.css">
45+
46+
<!-- Custom theme stylesheets -->
47+
48+
49+
50+
</head>
51+
<body>
52+
<!-- Provide site root to javascript -->
53+
<script type="text/javascript">
54+
var path_to_root = "";
55+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
56+
</script>
57+
58+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
59+
<script type="text/javascript">
60+
try {
61+
var theme = localStorage.getItem('mdbook-theme');
62+
var sidebar = localStorage.getItem('mdbook-sidebar');
63+
64+
if (theme.startsWith('"') && theme.endsWith('"')) {
65+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
66+
}
67+
68+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
69+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
70+
}
71+
} catch (e) { }
72+
</script>
73+
74+
<!-- Set the theme before any content is loaded, prevents flash -->
75+
<script type="text/javascript">
76+
var theme;
77+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
78+
if (theme === null || theme === undefined) { theme = default_theme; }
79+
var html = document.querySelector('html');
80+
html.classList.remove('no-js')
81+
html.classList.remove('light')
82+
html.classList.add(theme);
83+
html.classList.add('js');
84+
</script>
85+
86+
<!-- Hide / unhide sidebar before it is displayed -->
87+
<script type="text/javascript">
88+
var html = document.querySelector('html');
89+
var sidebar = 'hidden';
90+
if (document.body.clientWidth >= 1080) {
91+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
92+
sidebar = sidebar || 'visible';
93+
}
94+
html.classList.remove('sidebar-visible');
95+
html.classList.add("sidebar-" + sidebar);
96+
</script>
97+
98+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
99+
<div class="sidebar-scrollbox">
100+
<ol class="chapter"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="getting-started.html"><strong aria-hidden="true">2.</strong> Getting Started</a></li><li class="chapter-item expanded "><a href="clusteropenstack/configuration.html"><strong aria-hidden="true">3.</strong> Configuration</a></li><li class="chapter-item expanded "><a href="topics/index.html"><strong aria-hidden="true">4.</strong> Topics</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="topics/external-cloud-provider.html"><strong aria-hidden="true">4.1.</strong> external cloud provider</a></li><li class="chapter-item expanded "><a href="topics/mover.html"><strong aria-hidden="true">4.2.</strong> move from bootstrap</a></li><li class="chapter-item expanded "><a href="topics/troubleshooting.html"><strong aria-hidden="true">4.3.</strong> trouble shooting</a></li></ol></li></ol>
101+
</div>
102+
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
103+
</nav>
104+
105+
<div id="page-wrapper" class="page-wrapper">
106+
107+
<div class="page">
108+
109+
<div id="menu-bar-hover-placeholder"></div>
110+
<div id="menu-bar" class="menu-bar sticky bordered">
111+
<div class="left-buttons">
112+
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
113+
<i class="fa fa-bars"></i>
114+
</button>
115+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
116+
<i class="fa fa-paint-brush"></i>
117+
</button>
118+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
119+
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
120+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
121+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
122+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
123+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
124+
</ul>
125+
126+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
127+
<i class="fa fa-search"></i>
128+
</button>
129+
130+
</div>
131+
132+
<h1 class="menu-title">Kubernetes Cluster API Provider Openstack</h1>
133+
134+
<div class="right-buttons">
135+
136+
<a href="print.html" title="Print this book" aria-label="Print this book">
137+
<i id="print-button" class="fa fa-print"></i>
138+
</a>
139+
140+
141+
<a href="https://sigs.k8s.io/cluster-api-provider-openstack" title="Git repository" aria-label="Git repository">
142+
<i id="git-repository-button" class="fa fa-github"></i>
143+
</a>
144+
145+
</div>
146+
</div>
147+
148+
149+
<div id="search-wrapper" class="hidden">
150+
<form id="searchbar-outer" class="searchbar-outer">
151+
<input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
152+
</form>
153+
<div id="searchresults-outer" class="searchresults-outer hidden">
154+
<div id="searchresults-header" class="searchresults-header"></div>
155+
<ul id="searchresults">
156+
</ul>
157+
</div>
158+
</div>
159+
160+
161+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
162+
<script type="text/javascript">
163+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
164+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
165+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
166+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
167+
});
168+
</script>
169+
170+
<div id="content" class="content">
171+
<main>
172+
<h1><a class="header" href="#document-not-found-404" id="document-not-found-404">Document not found (404)</a></h1>
173+
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
174+
175+
</main>
176+
177+
<nav class="nav-wrapper" aria-label="Page navigation">
178+
<!-- Mobile navigation buttons -->
179+
180+
181+
182+
183+
<div style="clear: both"></div>
184+
</nav>
185+
</div>
186+
</div>
187+
188+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
189+
190+
191+
192+
</nav>
193+
194+
</div>
195+
196+
197+
<!-- Livereload script (if served using the cli tool) -->
198+
<script type="text/javascript">
199+
var socket = new WebSocket("ws://localhost:3000/__livereload");
200+
socket.onmessage = function (event) {
201+
if (event.data === "reload") {
202+
socket.close();
203+
location.reload();
204+
}
205+
};
206+
207+
window.onbeforeunload = function() {
208+
socket.close();
209+
}
210+
</script>
211+
212+
213+
214+
215+
216+
217+
218+
<script type="text/javascript">
219+
window.playground_copyable = true;
220+
</script>
221+
222+
223+
224+
225+
226+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
227+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
228+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
229+
230+
231+
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
232+
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
233+
<script src="book.js" type="text/javascript" charset="utf-8"></script>
234+
235+
<!-- Custom JS scripts -->
236+
237+
238+
239+
240+
</body>
241+
</html>

‎docs/book/book/FontAwesome/css/font-awesome.css

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/book/book/FontAwesome/fonts/FontAwesome.ttf

162 KB
Binary file not shown.

‎docs/book/book/FontAwesome/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)