From c08a91b54906f5231c2889832655d8737f8a223b Mon Sep 17 00:00:00 2001 From: katelyn martin Date: Thu, 26 Sep 2024 10:40:39 -0400 Subject: [PATCH] Apply misc. fixes to `Server` documentation (#1847) * Fix a typo in `Server` authorization policy docs This applies a typo fix across the 2.12, 2.13, 2.14, 2.15, 2.16, and 2-edge docs. This removes an extra "_and_" in a sentence: ```diff -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. ``` Signed-off-by: katelyn martin * Fix broken anchor link these `#accessPolicy` anchors don't work when clicking on the `accessPolicy` links on the website here: . this commit fixes these links, in the `2.16` and `2-edge` docs. i did not find this link broken elsewhere. Signed-off-by: katelyn martin --------- Signed-off-by: katelyn martin --- linkerd.io/content/2-edge/reference/authorization-policy.md | 4 ++-- linkerd.io/content/2.12/reference/authorization-policy.md | 2 +- linkerd.io/content/2.13/reference/authorization-policy.md | 2 +- linkerd.io/content/2.14/reference/authorization-policy.md | 2 +- linkerd.io/content/2.15/reference/authorization-policy.md | 2 +- linkerd.io/content/2.16/reference/authorization-policy.md | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/linkerd.io/content/2-edge/reference/authorization-policy.md b/linkerd.io/content/2-edge/reference/authorization-policy.md index 46ba134c93..afa255600a 100644 --- a/linkerd.io/content/2-edge/reference/authorization-policy.md +++ b/linkerd.io/content/2-edge/reference/authorization-policy.md @@ -43,7 +43,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who @@ -77,7 +77,7 @@ A `Server` spec may contain the following top level fields: {{< table >}} | field| value | |------|-------| -| `accessPolicy`| [accessPolicy](#accessPolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). | +| `accessPolicy`| [accessPolicy](#accesspolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). | | `podSelector`| A [podSelector](#podselector) selects pods in the same namespace. | | `port`| A port name or number. Only ports in a pod spec's `ports` are considered. | | `proxyProtocol`| Configures protocol discovery for inbound connections. Supersedes the `config.linkerd.io/opaque-ports` annotation. Must be one of `unknown`,`HTTP/1`,`HTTP/2`,`gRPC`,`opaque`,`TLS`. Defaults to `unknown` if not set. | diff --git a/linkerd.io/content/2.12/reference/authorization-policy.md b/linkerd.io/content/2.12/reference/authorization-policy.md index bc8e9fd4eb..c4f97feb01 100644 --- a/linkerd.io/content/2.12/reference/authorization-policy.md +++ b/linkerd.io/content/2.12/reference/authorization-policy.md @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who diff --git a/linkerd.io/content/2.13/reference/authorization-policy.md b/linkerd.io/content/2.13/reference/authorization-policy.md index c1280180f0..faf4bbb7a7 100644 --- a/linkerd.io/content/2.13/reference/authorization-policy.md +++ b/linkerd.io/content/2.13/reference/authorization-policy.md @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who diff --git a/linkerd.io/content/2.14/reference/authorization-policy.md b/linkerd.io/content/2.14/reference/authorization-policy.md index 1089b8f463..7bbdf12e58 100644 --- a/linkerd.io/content/2.14/reference/authorization-policy.md +++ b/linkerd.io/content/2.14/reference/authorization-policy.md @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who diff --git a/linkerd.io/content/2.15/reference/authorization-policy.md b/linkerd.io/content/2.15/reference/authorization-policy.md index 1089b8f463..7bbdf12e58 100644 --- a/linkerd.io/content/2.15/reference/authorization-policy.md +++ b/linkerd.io/content/2.15/reference/authorization-policy.md @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who diff --git a/linkerd.io/content/2.16/reference/authorization-policy.md b/linkerd.io/content/2.16/reference/authorization-policy.md index 46ba134c93..afa255600a 100644 --- a/linkerd.io/content/2.16/reference/authorization-policy.md +++ b/linkerd.io/content/2.16/reference/authorization-policy.md @@ -43,7 +43,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization], The general pattern for authorization is: -- A `Server` describes and a set of pods, and a single port on those pods. +- A `Server` describes a set of pods, and a single port on those pods. - Optionally, an `HTTPRoute` references that `Server` and describes a subset of HTTP traffic to it. - A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who @@ -77,7 +77,7 @@ A `Server` spec may contain the following top level fields: {{< table >}} | field| value | |------|-------| -| `accessPolicy`| [accessPolicy](#accessPolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). | +| `accessPolicy`| [accessPolicy](#accesspolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). | | `podSelector`| A [podSelector](#podselector) selects pods in the same namespace. | | `port`| A port name or number. Only ports in a pod spec's `ports` are considered. | | `proxyProtocol`| Configures protocol discovery for inbound connections. Supersedes the `config.linkerd.io/opaque-ports` annotation. Must be one of `unknown`,`HTTP/1`,`HTTP/2`,`gRPC`,`opaque`,`TLS`. Defaults to `unknown` if not set. |