Skip to content

Commit 17daeca

Browse files
authored
Merge pull request #1993 from shiftstack/v1alpha1docs
✨ Add API docs for v1alpha1
2 parents 0990569 + 8fe2114 commit 17daeca

File tree

8 files changed

+343
-22
lines changed

8 files changed

+343
-22
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
289289
rbac:roleName=manager-role
290290

291291
.PHONY: generate-api-docs
292-
generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha7 generate-api-docs-v1alpha6
292+
generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha7 generate-api-docs-v1alpha6 generate-api-docs-v1alpha1
293293
generate-api-docs-%: $(GEN_CRD_API_REFERENCE_DOCS) FORCE
294294
$(GEN_CRD_API_REFERENCE_DOCS) \
295295
-api-dir=./api/$* \

api/v1alpha1/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,7 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17+
// package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group
18+
// +kubebuilder:object:generate=true
19+
// +groupName=infrastructure.cluster.x-k8s.io
1720
package v1alpha1

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@
1717
},
1818
{
1919
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1",
20-
"docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
21-
},
22-
{
23-
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1",
24-
"docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
20+
"docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/[email protected]"
2521
},
2622
{
2723
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/errors",
2824
"docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/[email protected]/errors#{{.TypeIdentifier}}"
25+
},
26+
{
27+
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta1",
28+
"docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api#infrastructure.cluster.x-k8s.io/v1beta1.{{.TypeIdentifier}}"
2929
}
3030
],
3131
"typeDisplayNamePrefixOverrides": {
3232
"k8s.io/api/": "Kubernetes ",
3333
"k8s.io/apimachinery/pkg/apis/": "Kubernetes "
3434
},
3535
"markdownDisabled": false
36-
}
36+
}

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [v1alpha6 to v1alpha7](./topics/crd-changes/v1alpha6-to-v1alpha7.md)
1414
- [v1alpha7 to v1beta1](./topics/crd-changes/v1alpha7-to-v1beta1.md)
1515
- [API reference](./api/index.md)
16+
- [v1alpha1](./api/v1alpha1/api.md)
1617
- [v1alpha6](./api/v1alpha6/api.md)
1718
- [v1alpha7](./api/v1alpha7/api.md)
1819
- [v1beta1](./api/v1beta1/api.md)

docs/book/src/api/v1alpha1/api.md

Lines changed: 317 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)