You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* template
Signed-off-by: Art Berger <art.berger@solo.io>
* hugo and versions.json
Signed-off-by: Art Berger <art.berger@solo.io>
* versions and shortcodes
Signed-off-by: Art Berger <art.berger@solo.io>
* version
Signed-off-by: Art Berger <art.berger@solo.io>
* latest to 2.1.x
Signed-off-by: Art Berger <art.berger@solo.io>
* main to latest
Signed-off-by: Art Berger <art.berger@solo.io>
* 2.3 main
Signed-off-by: Art Berger <art.berger@solo.io>
* relnotes
Signed-off-by: Art Berger <art.berger@solo.io>
---------
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art <artberger@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/release.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ assignees: ''
15
15
-[ ] Confirm that the upgrade and release note pages are updated. Typically, this is a separate issue.
16
16
-[ ] In `content/docs`, create the new `main` by making a copy of the current main directory. Rename the directories appropriately. For example, the old main is copied to a new `main`, the old main becomes `latest`, and the old latest becomes a `2.x.x` version.
17
17
-[ ] In the `hugo.yaml` file, update the `versions` to include the new minor version as main, the previous main as latest, and the previous latest as its version.
18
+
-[ ] In the `versions.json` file, update the `versions` to include the new minor version as main, the previous main as latest, and the previous latest as its version.
18
19
-[ ] Retire any version older than `n-3` (remove the directory and version from the `hugo.yaml` file)
19
20
-[ ] Update the version conrefs in the `assets/docs/versions` directory. Often, there is not a release for the next version, so you might have to use the same for latest and main.
20
21
-[ ] Add the release date to the version table in `assets/docs/pages/reference/versions.md`, and remove any retired versions.
@@ -35,4 +36,5 @@ assignees: ''
35
36
36
37
-[ ] Merge in the autogenerated PR that the workflow created
37
38
-[ ] Verify that the docs are published
38
-
-[ ] Cut a GitHub release of the docs repo for the new release, and include any retired version (such as `Release for 2.6.x and last state for retired 2.2.x`)
39
+
-[ ] Cut a GitHub release of the docs repo for the new release, and include any retired version (such as `Release for 2.6.x and last state for retired 2.2.x`)
40
+
-[ ] If maintaining a downstream version, update the content paths for the new version.
Copy file name to clipboardExpand all lines: assets/docs/pages/about/custom-resources.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ Kgateway uses the following custom resources to attach policies to routes and ga
67
67
68
68
*[**DirectResponse**]({{< link-hextra path="/traffic-management/direct-response/" >}}): Directly respond to incoming requests with a custom HTTP response code and body.
69
69
*[**HTTPListenerPolicy**]({{< link-hextra path="/about/policies/httplistenerpolicy/" >}}): Apply policies to all HTTP and HTTPS listeners.
70
-
*[**TrafficPolicy**](https://kgateway.dev/docs/envoy/main/about/policies/trafficpolicy/): Attach policies to routes in an HTTPRoute resource.
70
+
*[**TrafficPolicy**]({{< link-hextra path="/about/policies/trafficpolicy/" >}}): Attach policies to routes in an HTTPRoute resource.
Copy file name to clipboardExpand all lines: assets/docs/pages/about/policies-index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ While the {{< reuse "docs/snippets/k8s-gateway-api-name.md" >}} allows you to do
7
7
8
8
Kgateway uses the following custom resources to attach policies to routes and gateway listeners.
9
9
10
-
{{< version include-if="2.2.x,2.1.x" >}}
10
+
{{< version exclude-if="2.0.x" >}}
11
11
{{< cards >}}
12
12
{{< card link="../policies/backendconfigpolicy/" title="BackendConfigPolicy" subtitle="Configure connection settings to an upstream service." >}}
13
13
{{< card link="../../traffic-management/direct-response/" title="Direct response" subtitle="Directly respond to incoming requests with a custom HTTP response code and body." >}}
@@ -37,12 +37,12 @@ Review the policies that you can configure in kgateway and the level at which yo
37
37
|[External authorization](../../security/external-auth)| GatewayExtension and {{< reuse "docs/snippets/trafficpolicy.md" >}} |
Copy file name to clipboardExpand all lines: assets/docs/pages/install/advanced.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ For more information, see the [Helm reference docs]({{< link-hextra path="/refer
20
20
21
21
When using the development build {{< reuse "docs/versions/patch-dev.md" >}}, add `--set controller.image.pullPolicy=Always` to ensure you get the latest image. For production environments, this setting is not recommended as it might impact performance.
22
22
23
-
{{< version include-if="2.2.x" >}}
23
+
{{< version exclude-if="2.0.x,2.1.x" >}}
24
24
25
25
### Experimental Gateway API features {#experimental-gateway-api-features}
Copy file name to clipboardExpand all lines: assets/docs/pages/operations/upgrade.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -185,9 +185,8 @@ For Istio upgrades, consult the docs based on the way that you installed Istio.
185
185
186
186
4. Upgrade the {{< reuse "docs/snippets/kgateway.md">}} control plane Helm installation.
187
187
* Make sure to include your Helm values when you upgrade either as a configuration file or with `--set` flags. Otherwise, any previous custom values that you set might be overwritten.
188
-
* When using the development build v{{< reuse "docs/versions/patch-dev.md">}}, add the `--set controller.image.pullPolicy=Always` option to ensure you get the latest image. Alternatively, you can specify the exact image digest.{{< version include-if="2.2.x,2.1.x">}}
189
-
* To use experimental Gateway API features, include the experimental feature gate, `--set controller.extraEnv.KGW_ENABLE_GATEWAY_API_EXPERIMENTAL_FEATURES=true`.
190
-
{{< /version >}}
188
+
* When using the development build v{{< reuse "docs/versions/patch-dev.md">}}, add the `--set controller.image.pullPolicy=Always` option to ensure you get the latest image. Alternatively, you can specify the exact image digest.{{< version exclude-if="2.0.x">}}
189
+
* To use experimental Gateway API features, include the experimental feature gate, `--set controller.extraEnv.KGW_ENABLE_GATEWAY_API_EXPERIMENTAL_FEATURES=true`.{{< /version >}}
To learn more about how to generate these docs, see the [GitHub Workflows README](https://github.com/kgateway-dev/kgateway.dev/tree/main/.github/workflows/README.md).
0 commit comments