Skip to content

Commit 683bd4f

Browse files
authored
docs: update CRD doc template and remove dated info from configuration file doc (#150)
1 parent bf07565 commit 683bd4f

File tree

4 files changed

+6
-27
lines changed

4 files changed

+6
-27
lines changed

docs/configure.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,3 @@ metadata:
2828
spec:
2929
controllerName: "apisix.apache.org/apisix-ingress-controller"
3030
```
31-
32-
### Addresses
33-
34-
The `addresses` field records the status address of the Gateway.
35-
36-
```yaml
37-
apiVersion: gateway.networking.k8s.io/v1
38-
kind: Gateway
39-
metadata:
40-
name: gateway1
41-
spec:
42-
gatewayClassName: apisix
43-
listeners:
44-
- name: http
45-
port: 80
46-
protocol: HTTP
47-
status:
48-
addresses:
49-
- type: IPAddress
50-
value: 172.18.0.4
51-
```

docs/crd/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Resource Definitions API Reference
2+
title: Custom Resource Definitions API Reference
33
slug: /reference/apisix-ingress-controller/crd-reference
44
description: Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the APISIX Ingress Controller.
55
---
66

7-
This document provides the API resource description for the APISIX Ingress Controller.
7+
This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs).
88

99
## Packages
1010
- [apisix.apache.org/v1alpha1](#apisixapacheorgv1alpha1)
@@ -157,7 +157,7 @@ _Base type:_ `LocalPolicyTargetReferenceWithSectionName`
157157
| `group` _[Group](#group)_ | Group is the group of the target resource. |
158158
| `kind` _[Kind](#kind)_ | Kind is kind of the target resource. |
159159
| `name` _[ObjectName](#objectname)_ | Name is the name of the target resource. |
160-
| `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:<br /><br /> * Gateway: Listener name * HTTPRoute: HTTPRouteRule name * Service: Port name<br /><br /> 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. |
160+
| `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:<br /><br /> Gateway: Listener name<br /> • HTTPRoute: HTTPRouteRule name<br /> • Service: Port name<br /><br /> 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. |
161161

162162

163163
_Appears in:_

docs/template/gv_list.tpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
{{- $groupVersions := . -}}
33

44
---
5-
title: Resource Definitions API Reference
5+
title: Custom Resource Definitions API Reference
66
slug: /reference/apisix-ingress-controller/crd-reference
77
description: Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the APISIX Ingress Controller.
88
---
99

10-
This document provides the API resource description for the APISIX Ingress Controller.
10+
This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs).
1111

1212
## Packages
1313
{{- range $groupVersions }}

docs/template/type_members.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Please refer to the Kubernetes API documentation for details on the `metadata` field.
55
{{- else -}}
66
{{- /* First replace makes paragraphs separated, second merges lines in paragraphs. */ -}}
7-
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " }}
7+
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " | replace " *" "<br /> •" | replace "<br /><br /><br />" "<br /><br />" }}
88
{{- end -}}
99
{{- end -}}

0 commit comments

Comments
 (0)