docs: update getting started docs (RC2) (#2481)

.github/workflows/apisix-conformance-test.yml

@@ -46,7 +46,7 @@ jobs:
         id: go
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Install kind
         run: |
@@ -71,7 +71,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Login to Registry
         uses: docker/login-action@v1

.github/workflows/apisix-e2e-test.yml

@@ -43,7 +43,7 @@ jobs:
         id: go
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Install kind
         run: |
@@ -71,7 +71,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Login to Registry
         uses: docker/login-action@v1

.github/workflows/conformance-test.yml

@@ -43,7 +43,7 @@ jobs:
         id: go
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Install kind
         run: |
@@ -69,7 +69,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
       - name: Login to Registry
         uses: docker/login-action@v1
         with:

.github/workflows/e2e-test.yml

@@ -43,7 +43,7 @@ jobs:
         id: go
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Install kind
         run: |
@@ -68,7 +68,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Login to Registry
         uses: docker/login-action@v1

.github/workflows/golangci-lint.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: check go path for debug
         run: go env
@@ -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/reference/api-reference.md; then
+            echo "docs/en/latest/reference/api-reference.md has changed. Please run 'make generate-crd-docs' and commit the updated file."
             exit 1
           fi

.github/workflows/lint-checker.yml

@@ -29,13 +29,48 @@ on:
       - release-v2-dev
 
 jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+      go: ${{ steps.filter.outputs.go }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: ./.github/actions/paths-filter
+        id: filter
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          filters: |
+            docs:
+              - 'docs/**/*'
+              - '*.md'
+            go:
+              - '*.go'
+              - '**/*.go'
+              - 'go.mod'
+              - 'go.sum'
+              - 'Makefile'
+              - 'Dockerfile'
+              - 'test/e2e/**/*'
+              - 'conf/**'
+              - 'utils/**'
+              - ".github/**"
+
   run-test:
+    needs: changes
+    if: |
+      (needs.changes.outputs.go == 'true')
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: '1.21'
+          go-version: "1.23"
       - name: run gofmt
         working-directory: ./
         run: |
@@ -46,6 +81,9 @@ jobs:
               exit 1
           fi
   markdownlint:
+    needs: changes
+    if: |
+      (needs.changes.outputs.docs == 'true')
     name: 🍇 Markdown
     runs-on: ubuntu-latest
     steps:
@@ -55,8 +93,15 @@ jobs:
         with:
           node-version: '20.7.x'
       - run: npm install -g [email protected]
-      - run: markdownlint '**/*.md' --ignore node_modules --ignore CHANGELOG.md --ignore docs/en/latest/references/v2.md
+      - run: |
+          markdownlint '**/*.md' \
+            --ignore node_modules \
+            --ignore CHANGELOG.md \
+            --ignore docs/en/latest/reference/api-reference.md
   markdown-link-check:
+    needs: changes
+    if: |
+      (needs.changes.outputs.docs == 'true')
     runs-on: ubuntu-latest
     name: Check Markdown links
     steps:
@@ -68,8 +113,8 @@ jobs:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'yes'
           config-file: 'link-check-config.json'
-          folder-path: 'docs/en'
-          file-path: './README.md, ./install.md, ./test/e2e/README.md'
+          folder-path: 'docs'
+          file-path: './README.md'
           max-depth: -1
           file-extension: ".md"
           check-modified-files-only: "no"

.github/workflows/push-docker-v2-dev.yaml

@@ -35,7 +35,7 @@ jobs:
     - name: Setup Go Env
       uses: actions/setup-go@v4
       with:
-        go-version: "1.22"
+        go-version: "1.23"
 
 #    - name: Set up QEMU
 #      uses: docker/setup-qemu-action@v3

.github/workflows/push-docker.yaml

@@ -33,7 +33,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

.github/workflows/unit-test.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Setup Go Env
         uses: actions/setup-go@v4
         with:
-          go-version: "1.22"
+          go-version: "1.23"
       - name: Run unit test
         working-directory: ./
         run: |

Makefile

@@ -41,7 +41,7 @@ E2E_NODES ?= 2
 CRD_REF_DOCS_VERSION ?= v0.1.0
 CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
 CRD_DOCS_CONFIG ?= docs/assets/crd/config.yaml
-CRD_DOCS_OUTPUT ?= docs/en/latest/api-reference.md
+CRD_DOCS_OUTPUT ?= docs/en/latest/reference/api-reference.md
 CRD_DOCS_TEMPLATE ?= docs/assets/template
 
 export KUBECONFIG = /tmp/$(KIND_NAME).kubeconfig

README.md

@@ -15,7 +15,7 @@ The APISIX Ingress Controller allows you to run the APISIX Gateway as a Kubernet
 
 ### Prerequisites
 
-* go version v1.22.0+
+* go version v1.23.0+
 * docker version 17.03+.
 * kubectl version v1.11.3+.
 * Access to a Kubernetes v1.11.3+ cluster.

docs/assets/template/gv_details.tpl

@@ -39,7 +39,7 @@
 
 ### Types
 
-In this section you will find types that the CRDs rely on.
+This section describes the types used by the CRDs.
 
 {{- /* Display Types that are not exported Kinds */ -}}
 {{- range $typ := $gv.SortedTypes -}}

docs/assets/template/gv_list.tpl

@@ -22,11 +22,11 @@
 
 ---
 title: Custom Resource Definitions API Reference
-slug: /reference/apisix-ingress-controller/crd-reference
+slug: /reference/apisix-ingress-controller/api-reference
 description: Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the APISIX Ingress Controller.
 ---
 
-This document provides the API resource description the APISIX Ingress Controller custom resource definitions (CRDs).
+This document provides the API resource description for the APISIX Ingress Controller custom resource definitions (CRDs).
 
 ## Packages
 {{- range $groupVersions }}

docs/en/latest/config.json

@@ -3,7 +3,18 @@
     "sidebar": [
         {
             "type": "doc",
-            "id": "getting-started"
+            "id": "overview"
+        },
+        {
+            "type": "category",
+            "label": "Getting Started",
+            "items": [
+                "getting-started/get-apisix-ingress-controller",
+                "getting-started/configure-routes",
+                "getting-started/load-balancing",
+                "getting-started/key-authentication",
+                "getting-started/rate-limiting"
+            ]
         },
         {
             "type": "category",
@@ -23,8 +34,12 @@
             "id": "developer-guide"
         },
         {
-            "type": "doc",
-            "id": "api-reference"
+            "type": "category",
+            "label": "Reference",
+            "items": [
+                "reference/api-reference",
+                "reference/example"
+            ]
         },
         {
             "type": "doc",