Skip to content

Commit

Permalink
Merge pull request #1135 from salasberryfin/book-initial-version
Browse files Browse the repository at this point in the history
Create CAPG book from existing docs
  • Loading branch information
k8s-ci-robot authored Feb 16, 2024
2 parents 57eccc3 + dff85fd commit f710e86
Show file tree
Hide file tree
Showing 9 changed files with 646 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/book/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[book]
authors = ["The Cluster API Provider GCP Maintainers"]
language = "en"
multilingual = false
src = "src"
title = "Kubernetes Cluster API Provider GCP"

[output.html]
curly-quotes = true
git-repository-url = "https://sigs.k8s.io/cluster-api-provider-gcp"
no-section-label = true

[output.html.redirect]
"/agenda.html" = "/agenda/2024.html"
"/agenda/2024.html" = "https://docs.google.com/document/d/1l8B947Je79ZJX7zmKnJyMcOMIWjNidvp5FMTnPAY72I/"

[preprocessor.tabulate]
command = "mdbook-tabulate"

[preprocessor.embed]
command = "mdbook-embed"

[preprocessor.releaselink]
command = "mdbook-releaselink"
21 changes: 21 additions & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Summary

[Introduction](./introduction.md)
- [Getting Started](./getting-started.md)
- [Topics](./topics/index.md)
- [Prerequisites](./topics/prerequisites.md)
- [Conformance](./topics/conformance.md)
- [GKE Support](./topics/gke/index.md)
- [Creating a Cluster](./topics/gke/creating-a-cluster.md)
- [Cluster Upgrades](./topics/gke/cluster-upgrades.md)
- [Enabling](./topics/gke/enabling.md)
- [Disabling](./topics/gke/disabling.md)
- [Machine Locations](./topics/machine-locations.md)
- [Preemptible VMs](./topics/preemptible-vms.md)
- [Flannel](./topics/flannel.md)
- [Developer Guide](./developers/index.md)
- [Development](./developers/development.md)
- [Creating a cluster](./developers/cluster-creation.md)
- [CI Jobs](./developers/jobs.md)
- [Releasing](./developers/releasing.md)
- [Roadmap](./roadmap.md)
3 changes: 3 additions & 0 deletions docs/book/src/developers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Everything you need to know about contributing to CAPG.

If you are new to the project and want to help but don't know where to start, you can refer to the [Cluster API contributing guide](https://github.com/kubernetes-sigs/cluster-api/blob/main/CONTRIBUTING.md).
1 change: 1 addition & 0 deletions docs/book/src/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{#embed-github repo:"kubernetes-sigs/cluster-api" path:"docs/book/src/user/quick-start.md"}}
1 change: 1 addition & 0 deletions docs/book/src/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{#include ../../../README.md}}
1 change: 1 addition & 0 deletions docs/book/src/topics/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This section contains information about the main CAPG features and how to use them.
Loading

0 comments on commit f710e86

Please sign in to comment.