more fixes

nginx · Jun 6, 2024 · c61ae14 · c61ae14
1 parent 97b2501
commit c61ae14
Show file tree

Hide file tree

Showing 8 changed files with 533 additions and 405 deletions.
diff --git a/apis/v1alpha1/clientsettingspolicy_types.go b/apis/v1alpha1/clientsettingspolicy_types.go
@@ -5,6 +5,7 @@ import (
 	gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
+// +genclient
 // +kubebuilder:object:root=true
 // +kubebuilder:storageversion
 // +kubebuilder:subresource:status

diff --git a/apis/v1alpha1/nginxgateway_types.go b/apis/v1alpha1/nginxgateway_types.go
@@ -2,6 +2,7 @@ package v1alpha1
 
 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+// +genclient
 // +kubebuilder:object:root=true
 // +kubebuilder:storageversion
 // +kubebuilder:subresource:status

diff --git a/apis/v1alpha1/nginxproxy_types.go b/apis/v1alpha1/nginxproxy_types.go
@@ -2,6 +2,7 @@ package v1alpha1
 
 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+// +genclient
 // +kubebuilder:object:root=true
 // +kubebuilder:storageversion
 // +kubebuilder:resource:categories=nginx-gateway-fabric,scope=Cluster

diff --git a/apis/v1alpha1/observabilitypolicy_types.go b/apis/v1alpha1/observabilitypolicy_types.go
@@ -5,6 +5,7 @@ import (
 	gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
+// +genclient
 // +kubebuilder:object:root=true
 // +kubebuilder:storageversion
 // +kubebuilder:subresource:status
@@ -27,7 +28,6 @@ type ObservabilityPolicy struct {
 }
 
 // +kubebuilder:object:root=true
-
 // ObservabilityPolicyList contains a list of ObservabilityPolicies.
 type ObservabilityPolicyList struct {
 	metav1.TypeMeta `json:",inline"`

diff --git a/site/config/api/pkg.tpl b/site/config/api/pkg.tpl
@@ -3,7 +3,7 @@
 title: "API Reference"
 description: "NGINX Gateway API Reference"
 weight: 100
-toc: true
+toc: false
 ---
 
 {{ with .packages}}
@@ -24,15 +24,13 @@ toc: true
 
     {{ with (index .GoPackages 0 )}}
         {{ with .DocComments }}
-        <div>
+        <p>
             {{ safe (renderComments .) }}
-        </div>
+        </p>
         {{ end }}
     {{ end }}
 
-    {{- if (gt 0 (len (visibleTypes (sortedTypes .Types)))) -}}
     Resource Types:
-    {{- end -}}
     <ul>
     {{- range (visibleTypes (sortedTypes .Types)) -}}
         {{ if isExportedType . -}}

diff --git a/site/config/api/type.tpl b/site/config/api/type.tpl
@@ -2,24 +2,26 @@
 
 <h3 id="{{ anchorIDForType . }}">
     {{- .Name.Name }}
-    {{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias){{ end -}}
+    {{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias)</p>{{ end -}}
+    <a class="headerlink" href="#{{ anchorIDForType . }}" title="Permanent link">¶</a>
 </h3>
 {{ with (typeReferences .) }}
     <p>
         (<em>Appears on: </em>
         {{- $prev := "" -}}
         {{- range . -}}
-            {{- if $prev -}}, {{ end -}}
-            {{- $prev = . -}}
+            {{- if $prev -}},{{ end -}}
+            {{ $prev = . }}
             <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a>
         {{- end -}}
         )
     </p>
 {{ end }}
 
-<div>
+
+<p>
     {{ safe (renderComments .CommentLines) }}
-</div>
+</p>
 
 {{ with (constantsOfType .) }}
 <table class="table table-bordered table-striped">

diff --git a/site/content/how-to/monitoring/tracing.md b/site/content/how-to/monitoring/tracing.md
@@ -66,6 +66,8 @@ To enable tracing, you must configure two resources:
 
 - `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.
 
+Foe all the possible configuration options for these resources, see the [API reference]({{< relref "reference/api.md" >}}).
+
 ### Install NGINX Gateway Fabric with global tracing configuration
 
 {{< note >}}Ensure that you [install the Gateway API resources]({{< relref "installation/installing-ngf/helm.md#installing-the-gateway-api-resources" >}}).{{< /note >}}