Skip to content

Commit 2e0bb8a

Browse files
authored
chore: move doc to en/latest directory (#2443)
1 parent bb378f8 commit 2e0bb8a

File tree

9 files changed

+9
-10
lines changed

9 files changed

+9
-10
lines changed

.github/workflows/golangci-lint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
make generate-crd-docs
6161
- name: Check CRD Docs Diff
6262
run: |
63-
if ! git diff --exit-code -- docs/crd/api.md; then
64-
echo "docs/crd/api.md has changed. Please run 'make generate-crd-docs' and commit the updated file."
63+
if ! git diff --exit-code -- docs/en/latest/api-reference.md; then
64+
echo "docs/en/latest/api-reference.md has changed. Please run 'make generate-crd-docs' and commit the updated file."
6565
exit 1
6666
fi

.github/workflows/lint-checker.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,7 @@ jobs:
9696
markdownlint '**/*.md' \
9797
--ignore node_modules \
9898
--ignore CHANGELOG.md \
99-
--ignore docs/crd/api.md \
100-
--ignore docs/gateway-api.md
99+
--ignore docs/en/latest/api-reference.md
101100
markdown-link-check:
102101
needs: changes
103102
if: |

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ TEST_DIR ?= ./test/e2e/apisix/
3737
CRD_REF_DOCS_VERSION ?= v0.1.0
3838
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
3939
CRD_DOCS_CONFIG ?= docs/crd/config.yaml
40-
CRD_DOCS_OUTPUT ?= docs/crd/api.md
40+
CRD_DOCS_OUTPUT ?= docs/en/latest/api-reference.md
4141

4242
# go
4343
VERSYM="github.com/apache/apisix-ingress-controller/internal/version._buildVersion"
File renamed without changes.

docs/concepts/deployment-architecture.md renamed to docs/en/latest/concepts/deployment-architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ The APISIX Ingress Controller is used to manage the APISIX Gateway as either a s
3131

3232
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.
3333

34-
![Admin API Architecture](../assets/images/ingress-admin-api-architecture.png)
34+
![Admin API Architecture](../../../assets/images/ingress-admin-api-architecture.png)
3535

3636
## Standalone Mode (Experimental)
3737

3838
APISIX runs independently without relying on etcd, supporting two sub-modes - file-driven (managing configuration through conf/apisix.yaml files) and API-driven (storing configuration in memory with full configuration management through the dedicated /apisix/admin/configs endpoint).
3939

4040
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.
4141

42-
![Standalone Architecture](../assets/images/ingress-standalone-architecture.png)
42+
![Standalone Architecture](../../../assets/images/ingress-standalone-architecture.png)
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Enable additional features not included in the standard Kubernetes Gateway API,
6868

6969
* HTTPRoutePolicy: Configures advanced traffic management and routing policies for HTTPRoute or Ingress resources, enhancing functionality without modifying the original resources.
7070

71-
![Gateway API Extensions Overview](../assets/images/gateway-api-extensions-resources.png)
71+
![Gateway API Extensions Overview](../../../assets/images/gateway-api-extensions-resources.png)
7272

7373
## Ingress API Extensions
7474

@@ -84,4 +84,4 @@ APISIX Ingress Controller CRDs extend Kubernetes functionality to provide declar
8484

8585
* ApisixTls: Manages SSL/TLS certificates, supporting SNI binding and mutual TLS for secure APISIX gateway connections.
8686

87-
![V2 CRDs Overview](../assets/images/v2-crds-api-resources.png)
87+
![V2 CRDs Overview](../../../assets/images/v2-crds-api-resources.png)
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ There were two main deployment architectures in 1.x.x:
4646

4747
#### Architecture in 2.0.0
4848

49-
![upgrade to 2.0.0 architecture](./assets/images/upgrade-to-architecture.png)
49+
![upgrade to 2.0.0 architecture](../../assets/images/upgrade-to-architecture.png)
5050

5151
##### Mock-ETCD Mode Deprecated
5252

0 commit comments

Comments
 (0)