From 7b3423319120496a2186b31d8f0d4f289f3aa683 Mon Sep 17 00:00:00 2001 From: Stefan Bueringer Date: Fri, 4 Feb 2022 12:37:11 +0100 Subject: [PATCH] book: Add API reference page --- docs/book/src/SUMMARY.md | 1 + docs/book/src/reference/api_reference.md | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 docs/book/src/reference/api_reference.md diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 0faa0b36227d..084857a0a1a2 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -74,6 +74,7 @@ - [CustomResourceDefinitions relationships](./developer/crd-relationships.md) - [Troubleshooting](./user/troubleshooting.md) - [Reference](./reference/reference.md) + - [API Reference](./reference/api_reference.md) - [Glossary](./reference/glossary.md) - [Provider List](./reference/providers.md) - [Ports](./reference/ports.md) diff --git a/docs/book/src/reference/api_reference.md b/docs/book/src/reference/api_reference.md new file mode 100644 index 000000000000..536b528e27ee --- /dev/null +++ b/docs/book/src/reference/api_reference.md @@ -0,0 +1,7 @@ +# API Reference + +Cluster API currently exposes the following APIs: + +* the Cluster API Custom Resource Definitions (CRDs): [documentation](https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api) + +* Golang APIs: [godoc](https://pkg.go.dev/sigs.k8s.io/cluster-api)