Apply suggestions from code review

Co-authored-by: Patryk Małek <[email protected]>
Kong · Oct 28, 2024 · a1ff544 · a1ff544
1 parent 1f00a26
commit a1ff544
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/app/_src/gateway-operator/guides/konnect-entities/consumer-and-consumergroup.md b/app/_src/gateway-operator/guides/konnect-entities/consumer-and-consumergroup.md
@@ -34,7 +34,7 @@ spec:
   controlPlaneRef:
     type: konnectNamespacedRef
     konnectNamespacedRef:
-      name: gateway-control-plane # KonnectGatewayControlPlane reference
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
   ' | kubectl apply -f -
 ```
 
@@ -80,7 +80,7 @@ metadata:
   namespace: default
 spec:
   consumerRef:
-    name: consumer
+    name: consumer # Reference to the KongConsumer object
   password: pass
   username: username
   ' | kubectl apply -f -
@@ -126,7 +126,7 @@ spec:
   controlPlaneRef:
     type: konnectNamespacedRef
     konnectNamespacedRef:
-      name: gateway-control-plane # KonnectGatewayControlPlane reference
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
 ' | kubectl apply -f -
 ```
 
@@ -167,12 +167,12 @@ metadata:
 username: consumer
 custom_id: 08433C12-2B81-4738-B61D-3AA2136F0212 # Optional
 consumerGroups:
-  - consumer-group # KongConsumerGroup reference
+  - consumer-group # Reference to the KongConsumerGroup object
 spec:
   controlPlaneRef:
     type: konnectNamespacedRef
     konnectNamespacedRef:
-      name: gateway-control-plane # KonnectGatewayControlPlane reference
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
   ' | kubectl apply -f -
 ```
 

diff --git a/app/_src/gateway-operator/guides/konnect-entities/key-and-keyset.md b/app/_src/gateway-operator/guides/konnect-entities/key-and-keyset.md
@@ -34,9 +34,9 @@ metadata:
   namespace: default
 spec:
   controlPlaneRef:
-    type: konnectNamespacedRef
+    type: konnectNamespacedRef # This indicates that an in cluster reference is used
     konnectNamespacedRef:
-      name: gateway-control-plane # KonnectGatewayControlPlane reference
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
   kid: key-id
   name: key
   pem:
@@ -98,7 +98,7 @@ metadata:
   namespace: default
 spec:
   controlPlaneRef:
-    type: konnectNamespacedRef
+    type: konnectNamespacedRef # This indicates that an in cluster reference is used
     konnectNamespacedRef:
       name: gateway-control-plane # KonnectGatewayControlPlane reference
   name: key-set
@@ -138,7 +138,7 @@ metadata:
   namespace: default
 spec:
   controlPlaneRef:
-    type: konnectNamespacedRef
+    type: konnectNamespacedRef # This indicates that an in cluster reference is used
     konnectNamespacedRef:
       name: gateway-control-plane # KonnectGatewayControlPlane reference
   kid: key-id

diff --git a/app/_src/gateway-operator/guides/konnect-entities/service-and-route.md b/app/_src/gateway-operator/guides/konnect-entities/service-and-route.md
@@ -32,9 +32,9 @@ spec:
   name: service
   host: example.com
   controlPlaneRef:
-    type: konnectNamespacedRef
+    type: konnectNamespacedRef # This indicates that an in cluster reference is used
     konnectNamespacedRef:
-      name: gateway-control-plane
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
   ' | kubectl apply -f -
 ```
 
@@ -131,7 +131,7 @@ spec:
   controlPlaneRef:
     type: konnectNamespacedRef
     konnectNamespacedRef:
-      name: gateway-control-plane # KonnectGatewayControlPlane reference
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
 ' | kubectl apply -f -
 ```
 

diff --git a/app/_src/gateway-operator/guides/konnect-entities/tagging-and-labeling.md b/app/_src/gateway-operator/guides/konnect-entities/tagging-and-labeling.md
@@ -71,7 +71,7 @@ spec:
   controlPlaneRef:
     type: konnectNamespacedRef
     konnectNamespacedRef:
-      name: gateway-control-plane
+      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
   ' | kubectl apply -f -
 ```
 

diff --git a/app/_src/gateway-operator/guides/konnect-entities/upstream-and-target.md b/app/_src/gateway-operator/guides/konnect-entities/upstream-and-target.md
@@ -31,7 +31,7 @@ metadata:
 spec:
   name: upstream
   controlPlaneRef:
-    type: konnectNamespacedRef
+    type: konnectNamespacedRef # This indicates that an in cluster reference is used
     konnectNamespacedRef:
       name: gateway-control-plane # KonnectGatewayControlPlane reference
   ' | kubectl apply -f -
@@ -75,7 +75,7 @@ metadata:
   namespace: default
 spec:
   upstreamRef:
-    name: upstream # KongUpstream reference
+    name: upstream # Reference to the KongUpstream object
   target: "10.0.0.1"
   weight: 30
 ---
@@ -86,7 +86,7 @@ metadata:
   namespace: default
 spec:
   upstreamRef:
-    name: upstream # KongUpstream reference
+    name: upstream # Reference to the KongUpstream object
   target: "10.0.0.2"
   weight: 70
   ' | kubectl apply -f -