From cc95965f3cb83aedb9ecfd27e1c87abc676f6ae6 Mon Sep 17 00:00:00 2001 From: traky Date: Wed, 21 May 2025 17:05:59 +0800 Subject: [PATCH 1/3] update CRD doc title and description --- docs/crd/api.md | 4 ++-- docs/template/gv_list.tpl | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/crd/api.md b/docs/crd/api.md index 6720899e0..e4eb4b8ac 100644 --- a/docs/crd/api.md +++ b/docs/crd/api.md @@ -1,10 +1,10 @@ --- -title: Resource Definitions API Reference +title: Custom Resource Definitions API Reference slug: /reference/apisix-ingress-controller/crd-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 for the APISIX Ingress Controller. +This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs). ## Packages - [apisix.apache.org/v1alpha1](#apisixapacheorgv1alpha1) diff --git a/docs/template/gv_list.tpl b/docs/template/gv_list.tpl index a6414c17c..4675fe3d8 100644 --- a/docs/template/gv_list.tpl +++ b/docs/template/gv_list.tpl @@ -2,12 +2,12 @@ {{- $groupVersions := . -}} --- -title: Resource Definitions API Reference +title: Custom Resource Definitions API Reference slug: /reference/apisix-ingress-controller/crd-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 for the APISIX Ingress Controller. +This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs). ## Packages {{- range $groupVersions }} From 3a26f3f9a387f220d8e63207ca755256e435b62a Mon Sep 17 00:00:00 2001 From: traky Date: Wed, 21 May 2025 17:24:31 +0800 Subject: [PATCH 2/3] update template with more replace --- docs/crd/api.md | 2 +- docs/template/type_members.tpl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/crd/api.md b/docs/crd/api.md index e4eb4b8ac..ca9521272 100644 --- a/docs/crd/api.md +++ b/docs/crd/api.md @@ -157,7 +157,7 @@ _Base type:_ `LocalPolicyTargetReferenceWithSectionName` | `group` _[Group](#group)_ | Group is the group of the target resource. | | `kind` _[Kind](#kind)_ | Kind is kind of the target resource. | | `name` _[ObjectName](#objectname)_ | Name is the name of the target resource. | -| `sectionName` _[SectionName](#sectionname)_ | SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following:

* Gateway: Listener name * HTTPRoute: HTTPRouteRule name * Service: Port name

If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status. | +| `sectionName` _[SectionName](#sectionname)_ | SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following:

• Gateway: Listener name
• HTTPRoute: HTTPRouteRule name
• Service: Port name

If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status. | _Appears in:_ diff --git a/docs/template/type_members.tpl b/docs/template/type_members.tpl index 164223a6a..391395987 100644 --- a/docs/template/type_members.tpl +++ b/docs/template/type_members.tpl @@ -4,6 +4,6 @@ Please refer to the Kubernetes API documentation for details on the `metadata` field. {{- else -}} {{- /* First replace makes paragraphs separated, second merges lines in paragraphs. */ -}} -{{ $field.Doc | replace "\n\n" "

" | replace "\n" " " }} +{{ $field.Doc | replace "\n\n" "

" | replace "\n" " " | replace " *" "
•" | replace "


" "

" }} {{- end -}} {{- end -}} From f09ebc75e7f4b386594f4504b03be816f8853cf7 Mon Sep 17 00:00:00 2001 From: traky Date: Wed, 21 May 2025 17:44:38 +0800 Subject: [PATCH 3/3] remove addresses from configure.md --- docs/configure.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/docs/configure.md b/docs/configure.md index ab21ff48a..06c69d5da 100644 --- a/docs/configure.md +++ b/docs/configure.md @@ -28,24 +28,3 @@ metadata: spec: controllerName: "apisix.apache.org/apisix-ingress-controller" ``` - -### Addresses - -The `addresses` field records the status address of the Gateway. - -```yaml -apiVersion: gateway.networking.k8s.io/v1 - kind: Gateway - metadata: - name: gateway1 - spec: - gatewayClassName: apisix - listeners: - - name: http - port: 80 - protocol: HTTP - status: - addresses: - - type: IPAddress - value: 172.18.0.4 -```