Merge pull request #1993 from shiftstack/v1alpha1docs

✨ Add API docs for v1alpha1

Author: k8s-ci-robot

Makefile

@@ -289,7 +289,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
 		rbac:roleName=manager-role
 
 .PHONY: generate-api-docs
-generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha7 generate-api-docs-v1alpha6
+generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha7 generate-api-docs-v1alpha6 generate-api-docs-v1alpha1
 generate-api-docs-%: $(GEN_CRD_API_REFERENCE_DOCS) FORCE
 	$(GEN_CRD_API_REFERENCE_DOCS) \
 		-api-dir=./api/$* \

api/v1alpha1/doc.go

@@ -14,4 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group
+// +kubebuilder:object:generate=true
+// +groupName=infrastructure.cluster.x-k8s.io
 package v1alpha1

docs/book/gen-crd-api-reference-docs/config.json

@@ -17,20 +17,20 @@
       },
       {
         "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1",
-        "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
-      },
-      {
-        "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1",
-        "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
+        "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
       },
       {
         "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/errors",
         "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/[email protected]/errors#{{.TypeIdentifier}}"
+      },
+      {
+        "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta1",
+        "docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api#infrastructure.cluster.x-k8s.io/v1beta1.{{.TypeIdentifier}}"
       }
     ],
     "typeDisplayNamePrefixOverrides": {
       "k8s.io/api/": "Kubernetes ",
       "k8s.io/apimachinery/pkg/apis/": "Kubernetes "
     },
     "markdownDisabled": false
-  }
+  }

docs/book/src/SUMMARY.md

@@ -13,6 +13,7 @@
         - [v1alpha6 to v1alpha7](./topics/crd-changes/v1alpha6-to-v1alpha7.md)
         - [v1alpha7 to v1beta1](./topics/crd-changes/v1alpha7-to-v1beta1.md)
 - [API reference](./api/index.md)
+    - [v1alpha1](./api/v1alpha1/api.md)
     - [v1alpha6](./api/v1alpha6/api.md)
     - [v1alpha7](./api/v1alpha7/api.md)
     - [v1beta1](./api/v1beta1/api.md)