Skip to content

Commit a310827

Browse files
author
Phillip Wittrock
authored
Merge pull request #485 from pwittrock/book-deps
Update GitBook Release Process
2 parents 88179ac + db29604 commit a310827

File tree

76 files changed

+3540
-424
lines changed

Some content is hidden

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

76 files changed

+3540
-424
lines changed

docs/book/RELEASE

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
To push the docs run:
22

3-
- gitbook install # optional
4-
- gitbook build # build the html files
5-
- copy files from _book/ to public/ # copy the files to the deploy dir
6-
- firebase deploy # deploy files to firebase
3+
## Install phantomJs
4+
5+
Install phantomJs which is required to build some images
6+
7+
- `$ npm install phantomjs-prebuilt`
8+
9+
## Install node_modules
10+
11+
Install these as they aren't checked into the repo.
12+
13+
- `$ npm ci`
14+
15+
## Run locally
16+
17+
Check that everything looks good
18+
19+
- `$ gitbook serve`
20+
21+
## Build the book
22+
23+
Build the index.html & friends
24+
25+
- `$ gitbook build`
26+
27+
## Push the book
28+
29+
Push the changes to firebase
30+
31+
- `$ firebase deploy`
32+
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Dockerfile,1542226555781,9e4e5fe2013b971a45f6b68810e356e8b9ec37477dd8f9ae03a770baf906759b
2+
RELEASE,1542226762263,abf2872b017ca0aea3cf9676a5a58db39b0f89d8bce4c8cf3ab344536c097a8a
3+
TODO.md,1542226555783,a3004749ac20c2e9aa8cda7aa3e68847fcf21f2e8739c0b06b08afdcd66318fe
4+
package.json,1542226762296,0af826bb9099036bdbc1dc611c8ed867564a39e787f5d631e80c81bd3ecb10c7
5+
index.html,1542226762294,400e3802fbcdc8ce2473c6af6c299304822d711f6c02963396b5aca43f7de67e
6+
go_docs.html,1542226762293,cfed9c9db276f8e1f22d173e82bca73480b266be2e507249804d8a6a3cc177a0
7+
quick_start.html,1542226762297,6f17eddec858200f5eb01e738b64687b6812befecb05f7ab3a778f4cbe31a368
8+
npm-shrinkwrap.json,1542226762295,d5b4fd3d7ecbaace1f17ce0ff391aeaee9331d6275670a34889d3132e14faab3
9+
basics/project_creation_and_structure.html,1542226762264,397a8a820e03d47c313ca110e31ea23aa882710dc9b5d50e3529ef0601b1aaf6
10+
basics/simple_controller_manager.html,1542226762266,790d367f82ec8663f8611d4234a77aabcee50742f454d25e59aae57094ac91e3
11+
basics/simple_controller.html,1542226762265,0764ca3da6aa73e34e5029084724bcbc767dbf686dc1621d5ec0ba37da964242
12+
basics/simple_resource.html,1542226762267,002479590216084fc4417fd9616858ce9c6af93acd398b3aaa11dbcbef003e60
13+
basics/status_subresource.html,1542226762268,873e7e80d17e69f16558f49901f9829383be4f69534254e923afbe29cfba1365
14+
basics/what_is_a_resource.html,1542226762270,ce3393d4928487c7ffe223cc73d4994de8771bbbac00e8f83bf3e15f2851b44d
15+
basics/what_is_the_controller_manager.html,1542226762271,2f83bc6dd46251a0771c2058f9ccafa0a3b11205bb6a32d05b1ad5b40ad7c7be
16+
beyond_basics/annotations.html,1542226762272,b80762817d7afb09992edc47c3e109d57af84a1b496e260543012c34ae332160
17+
beyond_basics/boilerplate.html,1542226762274,93b5bc68101f2ca54a614477586cb10c2a513cade5de70016629474c934b63cf
18+
beyond_basics/controller_watches.html,1542226762275,a34cc855b30e331775b99f3907de9ab6b5d604cd3c53ae0082d893460ca1261f
19+
beyond_basics/creating_events.html,1542226762277,a67fb48cfd85c1652855e309230ee9a9d26bf1dd300282431ed947be38ebbe21
20+
beyond_basics/controllers_for_core_resources.html,1542226762276,82fbe3c14f90c52bd2ffcba001d243759fc8876a9645869fbca68cd11e2a937e
21+
beyond_basics/dependencies.html,1542226762277,e2c75d3be8623efd8da5fa5c46e0a4ba25c2e69da7b3e0045fa98850b0709ee8
22+
beyond_basics/deploying_controller.html,1542226762278,a2663b5650c9c6a76d994e40fd8fe19a51161b9bce8d170d6755e9555edd2990
23+
beyond_basics/generating_documentation.html,1542226762279,8bbacc630edb55021d8f4a38de174679a0d856d8e2d6bcb20b681c744631d2b3
24+
beyond_basics/running_tests.html,1542226762280,8e7e8e5f916d941a1ab29e485afb78dba6a525abdde0664df6f9d8093d28a803
25+
beyond_basics/upgrading_kubebuilder.html,1542226762282,bd358f094ea5e293b216a8c0986b9d1a7c91455b89dec533089b0fbb28404880
26+
beyond_basics/sample_webhook.html,1542226762281,ce04ff1b468490bdd9858da81d24f64b9362b9e5e44feda3f442a0640249baac
27+
beyond_basics/using_client_go_informers.html,1542226762283,f9712e37855ff398435381790b7ee35316fe2863f40e2b0611759e102d4d6097
28+
beyond_basics/using_finalizers.html,1542226762284,1349607eda48d5c3bed34ebdd8487eaa5b99a8235839a3862ce4498b10eff14d
29+
beyond_basics/what_is_a_webhook.html,1542226762286,443e68a2f55e7f9403906e04867f1d0a35b59620e0ea8b9b2a290a40c308e9e7
30+
getting_started/hello_world.html,1542226762288,b04b11d32eefe442ff54e645e66533c7f059ebdee4720b1c08defa8035a1980e
31+
getting_started/installation_and_setup.html,1542226762289,b69a9669c1f2edb3218d888ebdfeeb38c3f36e1b9d4ff8a75f122399ee556985
32+
getting_started/why_kubernetes.html,1542226762292,c4906cd237aee53d8e5fba6bb7806d7ed7c38ca71becd3e65557b483f9348e47
33+
getting_started/what_is_kubebuilder.html,1542226762291,a0485410bb06cd9e4af55f60e09f4e31639b1f05b5aba794d6883042df8f0e30
34+
gitbook/gitbook-plugin-fontsettings/fontsettings.js,1542226555762,dfe69cc03a274c596ec6c715e33952f6e69f8dd013cbf7c3faf66eff13570ad0
35+
gitbook/gitbook-plugin-ga/plugin.js,1542226555773,0b27abaf6c5a9113a22a7380ddb2d2228839c6af45b684f5d94e3648ba10589e
36+
gitbook/gitbook-plugin-fontsettings/website.css,1542226555761,31253a8b92d2245724fb5d663513aac509495981bbe9c784a57a29975fb8074d
37+
gitbook/gitbook-plugin-highlight/ebook.css,1542226555771,9dd9e0874d7624022a9af676b3df942c6760b936b4f65eeecae11e68b2aee114
38+
gitbook/style.css,1542226555751,90c7003d3c185a98be02e0926d324a60c9ac6312d5741f67c1809702ea88b6e9
39+
gitbook/gitbook-plugin-lunr/lunr.min.js,1542226555765,a3528a0a973faa88b2e142dd88440ad7439eaeb292db7c10eb98387c71b97de6
40+
gitbook/gitbook-plugin-highlight/website.css,1542226555771,534fa10ae7e72d328e6e87baeef14cc51a21641d9422bcd5bf82b33b51134874
41+
basics/what_is_a_controller.html,1542226762269,6b8ac0eaf8f4ef01cde52cd983d9c5eb8d7d9c2b5c27270f0fa6b84fe752ba51
42+
gitbook/gitbook.js,1542226555753,e61e5f5446a6bf08db2a001bfba432ffd0cb8ad592fce7c4deb0bdce1012f9de
43+
gitbook/gitbook-plugin-panel/icons.css,1542226555776,fb7d846c06a1884e48433b59a43ec961331a0088f4a827b5d5e55180c3cb3209
44+
gitbook/gitbook-plugin-lunr/search-lunr.js,1542226555764,57936c36a51c115a9d4e506aac7fcda1fef821f384f704ab0705a4745adb5744
45+
gitbook/gitbook-plugin-panel/panel.css,1542226555775,2396093e8643550ac4d954232ca655a219ea7195e8cc2487031a6ad688723ba9
46+
gitbook/gitbook-plugin-panel/fonts/icomoon.eot,1542226555779,7f97a1eb03fead73dd518728e1896d251e5f5f27dd3b0514cf4042171995d3b8
47+
gitbook/gitbook-plugin-panel/fonts/icomoon.svg,1542226555778,150a8e561c2f2de2073129e8395cb1c6c2bc758619d4de8c4354f0241c368b59
48+
gitbook/gitbook-plugin-panel/fonts/icomoon.ttf,1542226555777,cf366585136db5e321fb5305c4f3360360df08b1faf8ed993c4c93dbb38b7a6b
49+
gitbook/gitbook-plugin-panel/fonts/icomoon.woff,1542226555776,5e2f977f7017b7c40fff4898686a068d6843a0292fc74dc11964e1b9af638d7e
50+
gitbook/gitbook-plugin-search/search-engine.js,1542226555768,4c765a6ac4c0cd7b9e63886b79166d4d43373ac7e784d1195bdd4cd67d4c242b
51+
gitbook/gitbook-plugin-search/search.css,1542226555768,c8bb6b66b25427319b62bf6f5a612d7ceed9f5809845512fa0b078f9fda1b542
52+
gitbook/gitbook-plugin-sharing/buttons.js,1542226555763,ebdcfb4cc60df5c087305acbaa1f35e42f517931a0e3d55527ae5cadf1e24247
53+
gitbook/gitbook-plugin-search/search.js,1542226555767,5e16baad1a23efb09fa2d2ad7e5f69535a493325086f8e0f9e1068ac4fa0466b
54+
gitbook/gitbook-plugin-search/lunr.min.js,1542226555769,a3528a0a973faa88b2e142dd88440ad7439eaeb292db7c10eb98387c71b97de6
55+
gitbook/gitbook-plugin-theme-api/theme-api.js,1542226555759,46cc48661ebe5b0263714db7903c52c44a4cbdf5959a857721b6a1af5dfe6ce1
56+
gitbook/gitbook-plugin-theme-api/theme-api.css,1542226555760,17c55af8c20d1611c1b8ec08526fd088a5be1c9df9c99ae8d4acdb2c839b7ffa
57+
gitbook/images/apple-touch-icon-precomposed-152.png,1542226555752,94df1e99e14c560391c8a89bea89326c4ccd42f9894697dbe2c0c9e9c3355f75
58+
gitbook/theme.js,1542226555749,7c226ebdfb3eda14ee388382ad4f752f9697a07ba5f2ba1e6de35d37c9fe729c
59+
gitbook/images/favicon.ico,1542226555752,261edb8810d0d8d33f7487aff5b282f3a5900199481ad064861c75ad63787d33
60+
gitbook/fonts/fontawesome/fontawesome-webfont.woff2,1542226555753,05d56e93dca40716c7f9a004363f5bef183d73d25537bda2019abbf2408ea30a
61+
gitbook/fonts/fontawesome/fontawesome-webfont.eot,1542226555757,27ce705fcb6bf8297752b7d51a515979538087b56ca12e08cfa688a335eebfb7
62+
gitbook/fonts/fontawesome/fontawesome-webfont.woff,1542226555754,b5e5438d32ce658324dd13b567bbfcbdee4157db75fc1723d87445b6b4023374
63+
gitbook/fonts/fontawesome/FontAwesome.otf,1542226555757,01466542b5271f67d488179f59503f336a4055134e1a8da045fe11fa5b43dcf4
64+
gitbook/fonts/fontawesome/fontawesome-webfont.ttf,1542226555755,a70d282cbe1e1a02a5d2c280cfeb1e0d47dce9ccb80de47bc6de5e83d2279e6b
65+
gitbook/fonts/fontawesome/fontawesome-webfont.svg,1542226555756,c8894706df38616d0bf883134738132cc4606e1895e665656d183dd007822e72
66+
search_index.json,1542226762302,adf9938409eac5651483afd5389de1bf1235050364bc8d32061af2174166a2fc

docs/book/_book/.firebaserc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}
File renamed without changes.

docs/book/_book/RELEASE

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
To push the docs run:
2+
3+
## Install phantomJs
4+
5+
Install phantomJs which is required to build some images
6+
7+
- `$ npm install phantomjs-prebuilt`
8+
9+
## Install node_modules
10+
11+
Install these as they aren't checked into the repo.
12+
13+
- `$ npm ci`
14+
15+
## Run locally
16+
17+
Check that everything looks good
18+
19+
- `$ gitbook serve`
20+
21+
## Build the book
22+
23+
Book the index.html & friends
24+
25+
- `$ gitbook build`
26+
27+
## Push the book
28+
29+
Push the changes to firebase
30+
31+
- `$ firebase deploy`
32+
File renamed without changes.

docs/book/public/basics/project_creation_and_structure.html renamed to docs/book/_book/basics/project_creation_and_structure.html

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,19 @@
259259

260260

261261

262+
</li>
263+
264+
<li class="chapter " data-level="3.2.3" data-path="status_subresource.html">
265+
266+
<a href="status_subresource.html">
267+
268+
269+
Status Subresource
270+
271+
</a>
272+
273+
274+
262275
</li>
263276

264277

@@ -581,6 +594,38 @@
581594
<span>
582595

583596

597+
Client-Go
598+
599+
</span>
600+
601+
602+
603+
<ul class="articles">
604+
605+
606+
<li class="chapter " data-level="4.4.1" data-path="../beyond_basics/using_client_go_informers.html">
607+
608+
<a href="../beyond_basics/using_client_go_informers.html">
609+
610+
611+
Generated Informers
612+
613+
</a>
614+
615+
616+
617+
</li>
618+
619+
620+
</ul>
621+
622+
</li>
623+
624+
<li class="chapter " data-level="4.5" >
625+
626+
<span>
627+
628+
584629
Deployment Workflow
585630

586631
</span>
@@ -590,7 +635,7 @@
590635
<ul class="articles">
591636

592637

593-
<li class="chapter " data-level="4.4.1" data-path="../beyond_basics/deploying_controller.html">
638+
<li class="chapter " data-level="4.5.1" data-path="../beyond_basics/deploying_controller.html">
594639

595640
<a href="../beyond_basics/deploying_controller.html">
596641

@@ -791,7 +836,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
791836
<script>
792837
var gitbook = gitbook || [];
793838
gitbook.push(function() {
794-
gitbook.page.hasChanged({"page":{"title":"Project Creation and Structure","level":"3.1.1","depth":2,"next":{"title":"Resources","level":"3.2","depth":1,"ref":"","articles":[{"title":"What is a Resource","level":"3.2.1","depth":2,"path":"basics/what_is_a_resource.md","ref":"basics/what_is_a_resource.md","articles":[]},{"title":"Resource Example","level":"3.2.2","depth":2,"path":"basics/simple_resource.md","ref":"basics/simple_resource.md","articles":[]}]},"previous":{"title":"Development Workflow","level":"3.1","depth":1,"ref":"","articles":[{"title":"Project Creation and Structure","level":"3.1.1","depth":2,"path":"basics/project_creation_and_structure.md","ref":"basics/project_creation_and_structure.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["theme-api","panel","sequence-diagrams","ga"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"panel":{},"search":{},"sequence-diagrams":{"theme":"simple"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"theme-api":{"languages":[],"split":true,"theme":"light"},"ga":{"configuration":"auto","token":"UA-119864590-1"},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"Phillip Wittrock","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"The Kubebuilder Book","gitbook":">= 3.0.0"},"file":{"path":"basics/project_creation_and_structure.md","mtime":"2018-08-03T23:37:28.642Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-22T21:02:37.732Z"},"basePath":"..","book":{"language":""}});
839+
gitbook.page.hasChanged({"page":{"title":"Project Creation and Structure","level":"3.1.1","depth":2,"next":{"title":"Resources","level":"3.2","depth":1,"ref":"","articles":[{"title":"What is a Resource","level":"3.2.1","depth":2,"path":"basics/what_is_a_resource.md","ref":"basics/what_is_a_resource.md","articles":[]},{"title":"Resource Example","level":"3.2.2","depth":2,"path":"basics/simple_resource.md","ref":"basics/simple_resource.md","articles":[]},{"title":"Status Subresource","level":"3.2.3","depth":2,"path":"basics/status_subresource.md","ref":"basics/status_subresource.md","articles":[]}]},"previous":{"title":"Development Workflow","level":"3.1","depth":1,"ref":"","articles":[{"title":"Project Creation and Structure","level":"3.1.1","depth":2,"path":"basics/project_creation_and_structure.md","ref":"basics/project_creation_and_structure.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["theme-api","panel","sequence-diagrams","ga"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"panel":{},"search":{},"sequence-diagrams":{"theme":"simple"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"theme-api":{"languages":[],"split":true,"theme":"light"},"ga":{"configuration":"auto","token":"UA-119864590-1"},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"Phillip Wittrock","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"The Kubebuilder Book","gitbook":">= 3.0.0"},"file":{"path":"basics/project_creation_and_structure.md","mtime":"2018-09-14T23:33:05.165Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-14T20:39:52.933Z"},"basePath":"..","book":{"language":""}});
795840
});
796841
</script>
797842
</div>

0 commit comments

Comments
 (0)