Skip to content

Commit

Permalink
Merge pull request #501 from droot/book/crd-gen-docs
Browse files Browse the repository at this point in the history 
book: added generating CRD documentation
  • Loading branch information
@k8s-ci-robot
k8s-ci-robot authored Nov 30, 2018
2 parents c6067b0 + 93530af commit 067f9e0
Show file tree
Hide file tree
Showing 35 changed files with 320 additions and 268 deletions.
2 changes: 1 addition & 1 deletion docs/book/SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* Development Workflow
* [Defining Boilerplate License Headers](beyond_basics/boilerplate.md)
* [Running Tests](beyond_basics/running_tests.md)
* [Using Annotation](beyond_basics/annotations.md)
* [Generating CRD](beyond_basics/generating_crd.md)
* [Generating API Documentation](beyond_basics/generating_documentation.md)
* [Updating Kubebuilder](beyond_basics/upgrading_kubebuilder.md)
* [Dependency Management](beyond_basics/dependencies.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/book/_book/basics/project_creation_and_structure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,12 +416,12 @@

</li>

<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/annotations.html">
<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/generating_crd.html">

<a href="../beyond_basics/annotations.html">
<a href="../beyond_basics/generating_crd.html">


Using Annotation
Generating CRD

</a>

Expand Down Expand Up @@ -836,7 +836,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
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-08-03T23:37:28.642Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-28T18:56:52.338Z"},"basePath":"..","book":{"language":""}});
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-08-03T23:37:28.642Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T18:51:45.140Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/book/_book/basics/simple_controller.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,12 +418,12 @@

</li>

<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/annotations.html">
<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/generating_crd.html">

<a href="../beyond_basics/annotations.html">
<a href="../beyond_basics/generating_crd.html">


Using Annotation
Generating CRD

</a>

Expand Down Expand Up @@ -775,8 +775,8 @@ <h4 id="reference">Reference</h4>
<ul>
<li>See the <a href="https://godoc.org/sigs.k8s.io/controller-runtime/pkg" target="_blank">controller libraries</a>
godocs for reference documentation on the controller libraries.</li>
<li>See the <a href="../beyond_basics/annotations.html">Using Annotations</a> to learn more
about hot use annotations in kubebuilder.</li>
<li>See the <a href="../beyond_basics/generating_crd.html">Generating CRD</a> to learn more
about how use annotations in kubebuilder.</li>
</ul>
</div><div class="api-method-code"><div class="api-method-sample" data-lang="go" data-name="Go"><pre><code class="lang-go"><span class="hljs-keyword">type</span> ContainerSetController <span class="hljs-keyword">struct</span> {
client.Client
Expand Down Expand Up @@ -950,7 +950,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Controller Example","level":"3.3.2","depth":2,"next":{"title":"Managers","level":"3.4","depth":1,"ref":"","articles":[{"title":"What is the Manager","level":"3.4.1","depth":2,"path":"basics/what_is_the_controller_manager.md","ref":"basics/what_is_the_controller_manager.md","articles":[]},{"title":"Manager Example","level":"3.4.2","depth":2,"path":"basics/simple_controller_manager.md","ref":"basics/simple_controller_manager.md","articles":[]}]},"previous":{"title":"What is a Controller","level":"3.3.1","depth":2,"path":"basics/what_is_a_controller.md","ref":"basics/what_is_a_controller.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/simple_controller.md","mtime":"2018-11-28T18:47:33.651Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-28T18:56:52.338Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Controller Example","level":"3.3.2","depth":2,"next":{"title":"Managers","level":"3.4","depth":1,"ref":"","articles":[{"title":"What is the Manager","level":"3.4.1","depth":2,"path":"basics/what_is_the_controller_manager.md","ref":"basics/what_is_the_controller_manager.md","articles":[]},{"title":"Manager Example","level":"3.4.2","depth":2,"path":"basics/simple_controller_manager.md","ref":"basics/simple_controller_manager.md","articles":[]}]},"previous":{"title":"What is a Controller","level":"3.3.1","depth":2,"path":"basics/what_is_a_controller.md","ref":"basics/what_is_a_controller.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/simple_controller.md","mtime":"2018-11-29T22:01:50.156Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T18:51:45.140Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/book/_book/basics/simple_controller_manager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,12 +418,12 @@

</li>

<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/annotations.html">
<li class="chapter " data-level="4.1.3" data-path="../beyond_basics/generating_crd.html">

<a href="../beyond_basics/annotations.html">
<a href="../beyond_basics/generating_crd.html">


Using Annotation
Generating CRD

</a>

Expand Down Expand Up @@ -795,7 +795,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Manager Example","level":"3.4.2","depth":2,"next":{"title":"Development Workflow","level":"4.1","depth":1,"ref":"","articles":[{"title":"Defining Boilerplate License Headers","level":"4.1.1","depth":2,"path":"beyond_basics/boilerplate.md","ref":"beyond_basics/boilerplate.md","articles":[]},{"title":"Running Tests","level":"4.1.2","depth":2,"path":"beyond_basics/running_tests.md","ref":"beyond_basics/running_tests.md","articles":[]},{"title":"Using Annotation","level":"4.1.3","depth":2,"path":"beyond_basics/annotations.md","ref":"beyond_basics/annotations.md","articles":[]},{"title":"Generating API Documentation","level":"4.1.4","depth":2,"path":"beyond_basics/generating_documentation.md","ref":"beyond_basics/generating_documentation.md","articles":[]},{"title":"Updating Kubebuilder","level":"4.1.5","depth":2,"path":"beyond_basics/upgrading_kubebuilder.md","ref":"beyond_basics/upgrading_kubebuilder.md","articles":[]},{"title":"Dependency Management","level":"4.1.6","depth":2,"path":"beyond_basics/dependencies.md","ref":"beyond_basics/dependencies.md","articles":[]}]},"previous":{"title":"What is the Manager","level":"3.4.1","depth":2,"path":"basics/what_is_the_controller_manager.md","ref":"basics/what_is_the_controller_manager.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/simple_controller_manager.md","mtime":"2018-07-18T17:30:29.368Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-28T18:56:52.338Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Manager Example","level":"3.4.2","depth":2,"next":{"title":"Development Workflow","level":"4.1","depth":1,"ref":"","articles":[{"title":"Defining Boilerplate License Headers","level":"4.1.1","depth":2,"path":"beyond_basics/boilerplate.md","ref":"beyond_basics/boilerplate.md","articles":[]},{"title":"Running Tests","level":"4.1.2","depth":2,"path":"beyond_basics/running_tests.md","ref":"beyond_basics/running_tests.md","articles":[]},{"title":"Generating CRD","level":"4.1.3","depth":2,"path":"beyond_basics/generating_crd.md","ref":"beyond_basics/generating_crd.md","articles":[]},{"title":"Generating API Documentation","level":"4.1.4","depth":2,"path":"beyond_basics/generating_documentation.md","ref":"beyond_basics/generating_documentation.md","articles":[]},{"title":"Updating Kubebuilder","level":"4.1.5","depth":2,"path":"beyond_basics/upgrading_kubebuilder.md","ref":"beyond_basics/upgrading_kubebuilder.md","articles":[]},{"title":"Dependency Management","level":"4.1.6","depth":2,"path":"beyond_basics/dependencies.md","ref":"beyond_basics/dependencies.md","articles":[]}]},"previous":{"title":"What is the Manager","level":"3.4.1","depth":2,"path":"basics/what_is_the_controller_manager.md","ref":"basics/what_is_the_controller_manager.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/simple_controller_manager.md","mtime":"2018-07-18T17:30:29.368Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T18:51:45.140Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
Expand Down
Loading

0 comments on commit 067f9e0

Please sign in to comment.