feat: Add API doc generation tools and update Makefile (#1459)

- Introduced a new Makefile target `generate-api-docs` to automate API documentation generation using the `crd-ref-docs` tool.
- Added a new script `build.sh` for generating API documentation, including configuration for the documentation process.
- Created new documentation files for API reference, detailing the Redis API groups and resource types.
- Removed the obsolete Redis API documentation index file to streamline the documentation structure.

Signed-off-by: yangw <[email protected]>

Author: drivebyer

Makefile

@@ -41,6 +41,7 @@ ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION)
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION)
 KUTTL = $(LOCALBIN)/kuttl-$(KUTTL_VERSION)
 KIND = $(LOCALBIN)/kind-$(KIND_VERSION)
+CRD_REF_DOCS = $(LOCALBIN)/crd-ref-docs-$(CRD_REF_DOCS_VERSION)
 
 # Tool Versions
 KUSTOMIZE_VERSION ?= v5.6.0
@@ -49,6 +50,7 @@ ENVTEST_VERSION ?= release-0.17
 GOLANGCI_LINT_VERSION ?= v2.2.2
 KUTTL_VERSION ?= 0.15.0
 KIND_VERSION ?= v0.24.0
+CRD_REF_DOCS_VERSION ?= v0.0.12
 
 # Options for 'bundle-build'
 ifneq ($(origin CHANNELS), undefined)
@@ -134,6 +136,11 @@ vet:
 generate: controller-gen
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+# Generate API documentation
+.PHONY: generate-api-docs
+generate-api-docs:
+	@hack/api-docs/build.sh
+
 # Create a new builder instance for Docker Buildx with the specified platforms and set it as the current builder
 .PHONY: docker-create
 docker-create:
@@ -169,7 +176,7 @@ bundle-build:
 
 # Rebuild all generated code
 .PHONY: codegen
-codegen: generate manifests sync-crds generate-dataAssert generate-metricsdocs
+codegen: generate manifests sync-crds generate-dataAssert generate-metricsdocs generate-api-docs
 
 # Verify that codegen is up to date.
 .PHONY: verify-codegen

docs/content/en/docs/CRD Reference/API Reference/_index.md

@@ -0,0 +1,32 @@
+---
+title: "API Reference"
+linkTitle: "API Reference"
+weight: 20
+date: 2025-01-27
+description: >
+  API reference
+---
+
+This section contains the API reference documentation generated using the `elastic/crd-ref-docs` tool, which provides improved documentation quality and maintenance.
+
+## API Groups Covered
+
+- `redis.redis.opstreelabs.in/v1beta2`
+- `rediscluster.redis.opstreelabs.in/v1beta2`
+- `redisreplication.redis.opstreelabs.in/v1beta2`
+- `redissentinel.redis.opstreelabs.in/v1beta2`
+- `common.redis.opstreelabs.in/v1beta2`
+
+## How to Generate
+
+To regenerate this documentation, run:
+
+```bash
+make generate-api-docs
+```
+
+Or directly:
+
+```bash
+hack/api-docs/build.sh
+```