Skip to content

Commit e9ffc3e

Browse files
committed
Use firebase for hosting the gitbook
1 parent 24a15ff commit e9ffc3e

Some content is hidden

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

64 files changed

+20342
-0
lines changed

docs/book/.firebaserc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

docs/book/firebase.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"hosting": {
3+
"public": "public",
4+
"ignore": [
5+
"firebase.json",
6+
"**/.*",
7+
"**/node_modules/**"
8+
]
9+
}
10+
}

docs/book/public/404.html

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<title>Page Not Found</title>
7+
8+
<style media="screen">
9+
body { background: #ECEFF1; color: rgba(0,0,0,0.87); font-family: Roboto, Helvetica, Arial, sans-serif; margin: 0; padding: 0; }
10+
#message { background: white; max-width: 360px; margin: 100px auto 16px; padding: 32px 24px 16px; border-radius: 3px; }
11+
#message h3 { color: #888; font-weight: normal; font-size: 16px; margin: 16px 0 12px; }
12+
#message h2 { color: #ffa100; font-weight: bold; font-size: 16px; margin: 0 0 8px; }
13+
#message h1 { font-size: 22px; font-weight: 300; color: rgba(0,0,0,0.6); margin: 0 0 16px;}
14+
#message p { line-height: 140%; margin: 16px 0 24px; font-size: 14px; }
15+
#message a { display: block; text-align: center; background: #039be5; text-transform: uppercase; text-decoration: none; color: white; padding: 16px; border-radius: 4px; }
16+
#message, #message a { box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24); }
17+
#load { color: rgba(0,0,0,0.4); text-align: center; font-size: 13px; }
18+
@media (max-width: 600px) {
19+
body, #message { margin-top: 0; background: white; box-shadow: none; }
20+
body { border-top: 16px solid #ffa100; }
21+
}
22+
</style>
23+
</head>
24+
<body>
25+
<div id="message">
26+
<h2>404</h2>
27+
<h1>Page Not Found</h1>
28+
<p>The specified file was not found on this website. Please check the URL for mistakes and try again.</p>
29+
<h3>Why am I seeing this?</h3>
30+
<p>This page was generated by the Firebase Command-Line Interface. To modify it, edit the <code>404.html</code> file in your project's configured <code>public</code> directory.</p>
31+
</div>
32+
</body>
33+
</html>

docs/book/public/Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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+
16+
FROM nginx
17+
18+
COPY _book /usr/share/nginx/html

docs/book/public/RELEASE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
To push the docs run:
2+
3+
Configure kubectl to talk to the kubebuilder "docs" GKE cluster.
4+
5+
- export IMAGE=gcr.io/kubebuilder/book:v<number>
6+
- gitbook build
7+
- docker build . -t $IMAGE
8+
- docker push $IMAGE
9+
- kubectl set image deployment gitbook-prod *=$IMAGE

docs/book/public/TODO.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
### Basics
2+
* Cmd Fundamentals
3+
* [Registering Controllers and Resources](basics/register_controllers_resources.md)
4+
* Development Workflow
5+
6+
### Beyond the Basics
7+
8+
* Resources
9+
* Atomic vs Associative Fields
10+
* Non-Namespaced Objects
11+
* Customizing Generated CRDs
12+
* Versioning Support
13+
* Validation with OpenAPI and Webhooks
14+
* Defaulting with Webhooks
15+
* Debugging Resources
16+
* Generated Code Deep Dive
17+
18+
* Controllers
19+
* Handling Read and Write Failures
20+
* Generating Unique Object Names
21+
* Finalizers and Garbage Collection
22+
* Logging and Publishing Events
23+
* Events, Shared Informers and RateLimiting Queues
24+
* Watching Non-Compiled In Types
25+
* Reading and Writing Non-Compiled In Types
26+
* Using Different rest.Configs for different Controllers
27+
* Debugging Controllers
28+
29+
* Controller Manager
30+
* Configuring How CRDs are Installed
31+
32+
### Publishing and Running in Production
33+
34+
* Integration Testing
35+
* Monitoring and Alerting
36+
* Build and Release
37+
* Packaging and Publishing

0 commit comments

Comments
 (0)