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 2e0bb8a1 chore: move doc to en/latest directory (#2443)
2e0bb8a1 is described below
commit 2e0bb8a13d8e0ca2fcc4da897c33cae3a7bae77a
Author: AlinsRan <alins...@apache.org>
AuthorDate: Wed Jul 2 15:57:55 2025 +0800
chore: move doc to en/latest directory (#2443)
---
.github/workflows/golangci-lint.yml | 4 ++--
.github/workflows/lint-checker.yml | 3 +--
Makefile | 2 +-
docs/{crd/api.md => en/latest/api-reference.md} | 0
docs/{ => en/latest}/concepts/deployment-architecture.md | 4 ++--
docs/{ => en/latest}/concepts/gateway-api.md | 0
docs/{ => en/latest}/concepts/resources.md | 4 ++--
docs/{ => en/latest}/configure.md | 0
docs/{ => en/latest}/upgrade-guide.md | 2 +-
9 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/.github/workflows/golangci-lint.yml
b/.github/workflows/golangci-lint.yml
index ae9be2be..cd150346 100644
--- a/.github/workflows/golangci-lint.yml
+++ b/.github/workflows/golangci-lint.yml
@@ -60,7 +60,7 @@ jobs:
make generate-crd-docs
- name: Check CRD Docs Diff
run: |
- if ! git diff --exit-code -- docs/crd/api.md; then
- echo "docs/crd/api.md has changed. Please run 'make
generate-crd-docs' and commit the updated file."
+ if ! git diff --exit-code -- docs/en/latest/api-reference.md; then
+ echo "docs/en/latest/api-reference.md has changed. Please run
'make generate-crd-docs' and commit the updated file."
exit 1
fi
diff --git a/.github/workflows/lint-checker.yml
b/.github/workflows/lint-checker.yml
index 1cfd2034..2cfff073 100644
--- a/.github/workflows/lint-checker.yml
+++ b/.github/workflows/lint-checker.yml
@@ -96,8 +96,7 @@ jobs:
markdownlint '**/*.md' \
--ignore node_modules \
--ignore CHANGELOG.md \
- --ignore docs/crd/api.md \
- --ignore docs/gateway-api.md
+ --ignore docs/en/latest/api-reference.md
markdown-link-check:
needs: changes
if: |
diff --git a/Makefile b/Makefile
index 3adeedf7..7ca53216 100644
--- a/Makefile
+++ b/Makefile
@@ -37,7 +37,7 @@ TEST_DIR ?= ./test/e2e/apisix/
CRD_REF_DOCS_VERSION ?= v0.1.0
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
CRD_DOCS_CONFIG ?= docs/crd/config.yaml
-CRD_DOCS_OUTPUT ?= docs/crd/api.md
+CRD_DOCS_OUTPUT ?= docs/en/latest/api-reference.md
# go
VERSYM="github.com/apache/apisix-ingress-controller/internal/version._buildVersion"
diff --git a/docs/crd/api.md b/docs/en/latest/api-reference.md
similarity index 100%
rename from docs/crd/api.md
rename to docs/en/latest/api-reference.md
diff --git a/docs/concepts/deployment-architecture.md
b/docs/en/latest/concepts/deployment-architecture.md
similarity index 92%
rename from docs/concepts/deployment-architecture.md
rename to docs/en/latest/concepts/deployment-architecture.md
index 31f730d1..e8b5c9b0 100644
--- a/docs/concepts/deployment-architecture.md
+++ b/docs/en/latest/concepts/deployment-architecture.md
@@ -31,7 +31,7 @@ The APISIX Ingress Controller is used to manage the APISIX
Gateway as either a s
In the traditional deployment approach, APISIX uses etcd as its configuration
center, allowing administrators to dynamically manage routes, upstreams, and
other resources through RESTful APIs. It supports distributed cluster
deployments with real-time configuration synchronization.
-
+
## Standalone Mode (Experimental)
@@ -39,4 +39,4 @@ APISIX runs independently without relying on etcd, supporting
two sub-modes - fi
This mode is particularly suitable for Kubernetes environments and single-node
deployments, where the API-driven memory management approach combines the
convenience of traditional Admin API with the simplicity of Standalone mode.
-
+
diff --git a/docs/concepts/gateway-api.md
b/docs/en/latest/concepts/gateway-api.md
similarity index 100%
rename from docs/concepts/gateway-api.md
rename to docs/en/latest/concepts/gateway-api.md
diff --git a/docs/concepts/resources.md b/docs/en/latest/concepts/resources.md
similarity index 96%
rename from docs/concepts/resources.md
rename to docs/en/latest/concepts/resources.md
index cb42d9fc..7359fd46 100644
--- a/docs/concepts/resources.md
+++ b/docs/en/latest/concepts/resources.md
@@ -68,7 +68,7 @@ Enable additional features not included in the standard
Kubernetes Gateway API,
* HTTPRoutePolicy: Configures advanced traffic management and routing policies
for HTTPRoute or Ingress resources, enhancing functionality without modifying
the original resources.
-
+
## Ingress API Extensions
@@ -84,4 +84,4 @@ APISIX Ingress Controller CRDs extend Kubernetes
functionality to provide declar
* ApisixTls: Manages SSL/TLS certificates, supporting SNI binding and mutual
TLS for secure APISIX gateway connections.
-
+
diff --git a/docs/configure.md b/docs/en/latest/configure.md
similarity index 100%
rename from docs/configure.md
rename to docs/en/latest/configure.md
diff --git a/docs/upgrade-guide.md b/docs/en/latest/upgrade-guide.md
similarity index 99%
rename from docs/upgrade-guide.md
rename to docs/en/latest/upgrade-guide.md
index 0a34b956..07473e2e 100644
--- a/docs/upgrade-guide.md
+++ b/docs/en/latest/upgrade-guide.md
@@ -46,7 +46,7 @@ There were two main deployment architectures in 1.x.x:
#### Architecture in 2.0.0
-
+
##### Mock-ETCD Mode Deprecated
