Repository navigation
[Automated] Draft docs (agentgateway): config store: reject writes validated against a stale snapshot (+4 related) - #1311
Open
github-actions[bot] wants to merge 1 commit into
Conversation
…lidated against a stale snapshot (+4 related) Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
47520cb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0a7f33bb.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-gytl.agentproxy.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[agentgateway/agentgateway#3656 plus #3866, #3919, #3923, #3929](agentgateway/agentgateway#3656, agentgateway/agentgateway#3866, agentgateway/agentgateway#3919, agentgateway/agentgateway#3923, agentgateway/agentgateway#3929) — UI configuration and filtering updates
Docs versions:
standalone/main. Not planned forkubernetes/main: no page found there. Check whether the change applies in that mode tooNo code-path rule covers 1 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:
crates/agentgateway/src/config_store.rsWhat changes for users: The UI save path is safer for editable configuration: YAML saves fall back to rewriting a validated file when an in-place update cannot preserve formatting, and database-backed saves are checked against the latest stored configuration before they are written. The Logs page can narrow Users and Groups filter values that were already discovered from stored traffic, and generated virtual API keys can be regenerated while editing a key. The source-build change in #3929 does not change published releases.
What the docs now say: The Launch the UI guide now explains YAML rewrite fallback and database save conflict protection. The access-log viewing page now says that Users and Groups filters have search boxes that narrow discovered values. The virtual keys guide now explains how to rotate a UI-generated key with Regenerate.
Not verified: No cluster or UI instance was available; the UI workflows are unrun.
How
agentgateway-3656was drafted, and what was not verifiedPlan, and what changed it
documentation/observability/access-logs/view.mdandassets/agw-docs/standalone/virtual-keys.md, already own the Logs filters and virtual key workflows.Why a documentation change is necessary
The UI launch page already tells readers that the UI can save configuration changes, but it did not explain the new YAML fallback or the database-backed save protection that #3656 and #3866 add. The access-log viewing page already mentions filtering logs by users, so #3919 belongs there rather than on a UI overview page. The virtual keys guide already documents creating generated keys in the UI, so #3923 belongs beside that workflow. For #3929, the dossier says release artifacts do not change, and the diff changes how source builds handle absent
ui/distassets.What changed on disk
assets/agw-docs/standalone/setup/ui/launch.md: Added UI save behavior for YAML rewrite fallback and database storage conflict protection.content/docs/standalone/main/documentation/observability/access-logs/view.md: Added the Users and Groups filter search behavior to the Logs UI steps.assets/agw-docs/standalone/virtual-keys.md: Added the regenerate flow for rotating a UI-generated virtual API key.How to verify this change
agw_sk_...value to copy.What was not verified
How the pages were chosen (triage report)
Feature clusters
These pull requests document one feature between them:
content/docs/standalone/main/documentation/llm/playground.md, the only page a code-path rule names for one of them, so separate pull requests would conflictKept apart on purpose. Merging wrongly produces a guide that documents two things and explains neither, so these are reported for a person to merge rather than grouped automatically:
content/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land therecontent/docs/standalone/main/documentation/llm/playground.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land thereThese clusters look incomplete. Each names a pull request this run never saw, so documenting the cluster as it stands may describe half a feature — the classic failure is a guide telling a reader to set a field that a later change gave a default. Read the absent pull request before drafting:
Draft a documentation change
agentgateway/agentgateway#3656 — config store: reject writes validated against a stale snapshot
agentgateway/website--validate-onlyafter drafting, and commands are unruncrates/agentgateway/src/config_store.rsagentgateway/agentgateway#3866 — ui: fallback if we cannot gracefully edit the yaml
agentgateway/website--validate-onlyafter drafting, and commands are unrunagentgateway/agentgateway#3919 — feat(ui): search the values offered by the user and group filters
agentgateway/website--validate-onlyafter drafting, and commands are unrunagentgateway/agentgateway#3923 — feat: allow to auto-gen a key on replacing
agentgateway/website--validate-onlyafter drafting, and commands are unrunNew configuration: no page mentions it yet
agentgateway/agentgateway#3929 — build: always include UI, just make it optional
agentgateway/website--validate-onlyafter drafting, and commands are unruncrates/agentgateway-app/build.rscrates/agentgateway-app/src/commands/run.rscrates/agentgateway-app/src/lib.rscrates/agentgateway/src/app.rscrates/agentgateway/src/management/admin.rsRelease notes
This pull request also adds its release-note entries:
content/docs/standalone/main/release-notes/release-notes.md: Agentgateway UI management workflows are safer to use (feature)Draft branch:
pr-tracker-draft-agentgateway-3656-plus4Important
The test suite has not run on this pull request. It was opened by
github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. Doc tests, link checking and the static checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Cloudflare Pages and DCO are GitHub Apps rather than Actions, so those two do run on their own.Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.