Add API docs for the FluxInstance custom resource

Signed-off-by: Stefan Prodan <[email protected]>
controlplaneio-fluxcd · Jun 3, 2024 · 2b13432 · 2b13432
1 parent 95a962f
commit 2b13432
Show file tree

Hide file tree

Showing 2 changed files with 470 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,10 @@ The Flux Operator comes with a Kubernetes CRD called `FluxInstance`. A single cu
 can exist in a Kubernetes cluster with the name `flux` that must be created in the same
 namespace where the operator is deployed.
 
+> [!TIP]
+> The `FluxInstance` API documentation is available at
+> [docs/api/v1](https://github.com/controlplaneio-fluxcd/flux-operator/blob/main/docs/api/v1/fluxinstance.md).
+
 ### Upstream Distribution
 
 To install the upstream distribution of Flux, create the following `FluxInstance` resource: