Background
Throughout the docs, we link out to the agentgateway/agentgateway examples repo: https://github.com/agentgateway/agentgateway/tree/main/examples
In the /static/_redirects, we have this redirect:
# Redirect all paths under /examples to GitHub raw content
/examples/* https://github.com/agentgateway/agentgateway/main/examples/:splat
Because of this redirect, the links throughout the docs to the examples look like the following examples
curl -L https://agentgateway.dev/examples/telemetry/config.yaml -o config.yaml
{{% github-yaml url="https://agentgateway.dev/examples/telemetry/config.yaml" %}}
Task 1 - older versions
this is fine for keeping examples in the docs sync'd to the latest changes in main codebase.
But for older versions, the examples in main often do not work.
For links in /content/{MODE}/1.2.x, update the links to the 1.2 tag: https://github.com/agentgateway/agentgateway/blob/v1.2.1/examples/ or raw file (example https://github.com/agentgateway/agentgateway/refs/tags/v1.2.1/examples/a2a/config.yaml)
- where
{MODE} is both kubernetes or standalone
- do similar for the other versions 1.1.x and 1.0.x and 2.2.x.
latest and main can keep using the main redirect
If the example links live in shared content in the /assets dir, use the {{< version >}} shortcode to handle the versioned links.
Task 2
For latest and main, the examples directory has changed significantly in its organization. These new examples are introduced and reorganized in this codebase PR: agentgateway/agentgateway#2242
- Find the current examples referred to in latest and main and update them to the new paths in agentgateway/agentgateway main branch
- identify any examples in the codebase that we do not currently use for examples in the docs to propose new places to add links to the examples
Background
Throughout the docs, we link out to the agentgateway/agentgateway examples repo: https://github.com/agentgateway/agentgateway/tree/main/examples
In the
/static/_redirects, we have this redirect:Because of this redirect, the links throughout the docs to the examples look like the following examples
Task 1 - older versions
this is fine for keeping examples in the docs sync'd to the latest changes in main codebase.
But for older versions, the examples in main often do not work.
For links in
/content/{MODE}/1.2.x, update the links to the 1.2 tag: https://github.com/agentgateway/agentgateway/blob/v1.2.1/examples/ or raw file (example https://github.com/agentgateway/agentgateway/refs/tags/v1.2.1/examples/a2a/config.yaml){MODE}is both kubernetes or standalonelatestandmaincan keep using the main redirectIf the example links live in shared content in the /assets dir, use the
{{< version >}}shortcode to handle the versioned links.Task 2
For latest and main, the examples directory has changed significantly in its organization. These new examples are introduced and reorganized in this codebase PR: agentgateway/agentgateway#2242