Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CAPG book from existing docs #1135

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading