This is an automated email from the ASF dual-hosted git repository.
alinsran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new 1a767b48 chore: move generate-crd to assets (#2445)
1a767b48 is described below
commit 1a767b48f6a37a0521733fba9b0b9b682b27975a
Author: AlinsRan <[email protected]>
AuthorDate: Thu Jul 3 09:55:50 2025 +0800
chore: move generate-crd to assets (#2445)
---
Makefile | 7 ++++---
docs/{ => assets}/crd/config.yaml | 0
docs/{ => assets}/template/gv_details.tpl | 0
docs/{ => assets}/template/gv_list.tpl | 0
docs/{ => assets}/template/type.tpl | 0
docs/{ => assets}/template/type_members.tpl | 0
6 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
index 7ca53216..27701ec6 100644
--- a/Makefile
+++ b/Makefile
@@ -36,8 +36,9 @@ TEST_DIR ?= ./test/e2e/apisix/
# CRD Reference Documentation
CRD_REF_DOCS_VERSION ?= v0.1.0
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
-CRD_DOCS_CONFIG ?= docs/crd/config.yaml
+CRD_DOCS_CONFIG ?= docs/assets/crd/config.yaml
CRD_DOCS_OUTPUT ?= docs/en/latest/api-reference.md
+CRD_DOCS_TEMPLATE ?= docs/assets/template
# go
VERSYM="github.com/apache/apisix-ingress-controller/internal/version._buildVersion"
@@ -361,7 +362,7 @@ generate-crd-docs: manifests ## Generate CRD reference
documentation in a single
--source-path=./api \
--config=$(CRD_DOCS_CONFIG) \
--renderer=markdown \
- --templates-dir=./docs/template \
+ --templates-dir=$(CRD_DOCS_TEMPLATE) \
--output-path=$(CRD_DOCS_OUTPUT) \
--max-depth=100
@echo "CRD reference documentation generated at $(CRD_DOCS_OUTPUT)"
@@ -374,7 +375,7 @@ generate-crd-docs-grouped: manifests ## Generate CRD
reference documentation gro
--source-path=./api \
--config=$(CRD_DOCS_CONFIG) \
--renderer=markdown \
- --templates-dir=./docs/template \
+ --templates-dir=$(CRD_DOCS_TEMPLATE) \
--output-path=docs/crd/groups \
--output-mode=group
@echo "CRD reference documentation generated in docs/crd/groups
directory"
diff --git a/docs/crd/config.yaml b/docs/assets/crd/config.yaml
similarity index 100%
rename from docs/crd/config.yaml
rename to docs/assets/crd/config.yaml
diff --git a/docs/template/gv_details.tpl b/docs/assets/template/gv_details.tpl
similarity index 100%
rename from docs/template/gv_details.tpl
rename to docs/assets/template/gv_details.tpl
diff --git a/docs/template/gv_list.tpl b/docs/assets/template/gv_list.tpl
similarity index 100%
rename from docs/template/gv_list.tpl
rename to docs/assets/template/gv_list.tpl
diff --git a/docs/template/type.tpl b/docs/assets/template/type.tpl
similarity index 100%
rename from docs/template/type.tpl
rename to docs/assets/template/type.tpl
diff --git a/docs/template/type_members.tpl
b/docs/assets/template/type_members.tpl
similarity index 100%
rename from docs/template/type_members.tpl
rename to docs/assets/template/type_members.tpl
