From 97b869dca029add8f96220fc9809d6ce4673ae9d Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Wed, 9 Oct 2024 14:22:08 -0600 Subject: [PATCH 1/3] Update docs/api.md and automatically update it Signed-off-by: Florent Poinsard --- Makefile | 3 + docs/api.md | 5963 ++++++++++++++++++++++++++++++++------------------- 2 files changed, 3777 insertions(+), 2189 deletions(-) diff --git a/Makefile b/Makefile index 36c6be63..0874bf80 100644 --- a/Makefile +++ b/Makefile @@ -32,6 +32,9 @@ integration-test: generate: go run sigs.k8s.io/controller-tools/cmd/controller-gen object crd:maxDescLen=0 paths="./pkg/apis/planetscale/v2" output:crd:artifacts:config=./deploy/crds go run github.com/ahmetb/gen-crd-api-reference-docs -api-dir planetscale.dev/vitess-operator/pkg/apis/planetscale/v2 -config ./docs/api/config.json -template-dir ./docs/api/template -out-file ./docs/api/index.html + @echo 'Copying ./docs/api/index.html to ./docs/api.md' + @cp ./docs/api/index.html ./docs/api.md && sed -i "" -e "1,2d" ./docs/api.md + @echo 'Written to ./docs/api.md' generate-and-diff: generate git add --all diff --git a/docs/api.md b/docs/api.md index 8ce4875e..06f2aee8 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,6 +1,22 @@ -

Vitess Operator API Reference

+ + + + +PlanetScale API Reference + + + +
+

planetscale.com/v2

-This page describes all the available fields of CRD APIs implemented by the operator. +

Package v2 contains API Schema definitions for the planetscale.com/v2 API group.

Resource Types

+ + + + + From 9053fd64117e9f45e56fb34a4cc30ce5da374b1a Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Wed, 9 Oct 2024 14:30:58 -0600 Subject: [PATCH 2/3] Update the title of the documentation Signed-off-by: Florent Poinsard --- docs/api.md | 4 ++-- docs/api/index.html | 4 ++-- docs/api/template/pkg.tpl | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api.md b/docs/api.md index 06f2aee8..8573ca14 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,11 +2,11 @@ -PlanetScale API Reference +Vitess Operator API Reference