Skip to content

Commit 3e55089

Browse files
committed
more fixes
1 parent 97b2501 commit 3e55089

File tree

8 files changed

+533
-404
lines changed

8 files changed

+533
-404
lines changed

apis/v1alpha1/clientsettingspolicy_types.go

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
66
)
77

8+
// +genclient
89
// +kubebuilder:object:root=true
910
// +kubebuilder:storageversion
1011
// +kubebuilder:subresource:status

apis/v1alpha1/nginxgateway_types.go

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package v1alpha1
22

33
import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
44

5+
// +genclient
56
// +kubebuilder:object:root=true
67
// +kubebuilder:storageversion
78
// +kubebuilder:subresource:status

apis/v1alpha1/nginxproxy_types.go

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package v1alpha1
22

33
import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
44

5+
// +genclient
56
// +kubebuilder:object:root=true
67
// +kubebuilder:storageversion
78
// +kubebuilder:resource:categories=nginx-gateway-fabric,scope=Cluster

apis/v1alpha1/observabilitypolicy_types.go

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
66
)
77

8+
// +genclient
89
// +kubebuilder:object:root=true
910
// +kubebuilder:storageversion
1011
// +kubebuilder:subresource:status

site/config/api/pkg.tpl

+3-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: "API Reference"
44
description: "NGINX Gateway API Reference"
55
weight: 100
6-
toc: true
6+
toc: false
77
---
88

99
{{ with .packages}}
@@ -24,15 +24,13 @@ toc: true
2424

2525
{{ with (index .GoPackages 0 )}}
2626
{{ with .DocComments }}
27-
<div>
27+
<p>
2828
{{ safe (renderComments .) }}
29-
</div>
29+
</p>
3030
{{ end }}
3131
{{ end }}
3232

33-
{{- if (gt 0 (len (visibleTypes (sortedTypes .Types)))) -}}
3433
Resource Types:
35-
{{- end -}}
3634
<ul>
3735
{{- range (visibleTypes (sortedTypes .Types)) -}}
3836
{{ if isExportedType . -}}

site/config/api/type.tpl

+7-5
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,26 @@
22

33
<h3 id="{{ anchorIDForType . }}">
44
{{- .Name.Name }}
5-
{{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias){{ end -}}
5+
{{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias)</p>{{ end -}}
6+
<a class="headerlink" href="#{{ anchorIDForType . }}" title="Permanent link">¶</a>
67
</h3>
78
{{ with (typeReferences .) }}
89
<p>
910
(<em>Appears on: </em>
1011
{{- $prev := "" -}}
1112
{{- range . -}}
12-
{{- if $prev -}}, {{ end -}}
13-
{{- $prev = . -}}
13+
{{- if $prev -}},{{ end -}}
14+
{{ $prev = . }}
1415
<a href="{{ linkForType . }}">{{ typeDisplayName . }}</a>
1516
{{- end -}}
1617
)
1718
</p>
1819
{{ end }}
1920

20-
<div>
21+
22+
<p>
2123
{{ safe (renderComments .CommentLines) }}
22-
</div>
24+
</p>
2325

2426
{{ with (constantsOfType .) }}
2527
<table class="table table-bordered table-striped">

site/content/how-to/monitoring/tracing.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ To enable tracing, you must configure two resources:
6666

6767
- `ObservabilityPolicy`: This resource is a [Direct PolicyAttachment](https://gateway-api.sigs.k8s.io/reference/policy-attachment/) that targets HTTPRoutes or GRPCRoutes. It is created by the [application developer](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/) and enables tracing for a specific route or routes. It requires the `NginxProxy` resource to exist in order to complete the tracing configuration.
6868

69+
Foe all the possible configuration options for these resources, see the [API reference]({{< relref "reference/api.md" >}}).
70+
6971
### Install NGINX Gateway Fabric with global tracing configuration
7072

7173
{{< note >}}Ensure that you [install the Gateway API resources]({{< relref "installation/installing-ngf/helm.md#installing-the-gateway-api-resources" >}}).{{< /note >}}

0 commit comments

Comments
 (0)