Repository navigation
docs(real-time-events): rework the Real-Time Events section - #2410
Merged
bruno-andrade-azion merged 5 commits intoOct 2, 2026
Merged
bruno-andrade-azion merged 5 commits into
bruno-andrade-azion merged 5 commits into
Conversation
The guide asserted that Real-Time Events provides an Edge Pulse data source. No source supports it: the data-source list has eight entries and none is Edge Pulse, the GraphQL field reference has ten datasets and none is Edge Pulse, and the page's own link to the variable list pointed at an anchor that does not exist. Everything it carried already lives on the Edge Pulse page: the five collected-data categories and the JavaScript tag. The six pages that linked it now point there, two of them through absolute URLs a relative sweep would have missed.
Real-Time Events had three pages for a resource that every other section links as its observability answer. The overview carried three kinds in one file: an overview, a 125-row variable reference, and a limits table. It is now an overview, a quickstart, and six pages that own what the overview was holding. The overview keeps its permalink and namespace, which roughly 185 pages link, and drops the Implementation section and a Preview tag that General Availability made stale in November 2025. Real-Time Events is a Platform Resource, not an Observe product. The knowledge base still says otherwise and needs correcting. The quickstart moves from first-steps to quickstart and takes Console and API tabs. Its redirect rechains an older row that pointed at the retired URL, so no reader traverses two hops.
…orked-query guides Eight guides rewritten. Seven opened with a How to title, none carried a kind, so the hub's Type column was blank on every row, and four of them were tagged with no product at all and therefore listed by no hub anywhere. Two defects were shipping values a reader cannot use. One guide wrote the same filter argument as statusIn: "403" and statusIn: [403] in adjacent queries, so whichever a reader copied had even odds of failing; only the list form survives. Another shipped two response bodies that are not valid JSON, fenced as bash, behind an Authorization: 123 header. The three new guides carry the worked queries the section had nowhere to put. The Examples slot is Functions-only here, so they ship as guides, in the shape the WAF example pages use.
… section Twenty pages, every namespace paired. The Portuguese side carried nine defects that were invisible from English and would have survived a straight translation: a guide sending readers to Data Stream for the Real-Time Events variable reference, another carrying both statusIn forms, a first-person "nos", a missing sentence that left a page linking the variable reference nowhere, four reversed rulings on the Grafana query guide, "edge applicatiom", and stray artifacts at three file ends. Translation also found four variables documented in Portuguese and never in English, in any version: Proxy Status on HTTP Requests, and Source on Image Processor, Edge DNS and Data Stream. Both languages now carry them, at 129 rows each.
bruno-andrade-azion
requested review from
a team,
isaque-bock-azion,
marcus-souza-azion and
pedro-ribeiro-azion
as code owners
October 2, 2026 20:15
The Real-Time Metrics rework landed on the base and overlaps this one in five files. The Grafana install guide is the substantive conflict: both reworks rewrote it. Real-Time Metrics renamed it, gave it a label override and made itself the owning product, so its version is taken whole and the two Real-Time Events guides that linked it by the old title are updated. The redirect files both grew by appending, and a plain union produced ten rows with one `from` and two targets, because each side rechained rows the other left alone. Resolved by keeping the terminal target per source: zero duplicate sources, and the rechain for the quickstart move survives.
marcus-souza-azion
approved these changes
Oct 2, 2026
bruno-andrade-azion
merged commit Oct 2, 2026
b7a88a0
into
release/new-azion-docs
5 of 7 checks passed
7 of 14 tasks
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
3 participants
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.
Summary
statusIn: "403"andstatusIn: [403]in adjacent queries, the other shipped two response bodies that are not valid JSON behind anAuthorization: 123header.How to test
pnpm build:local— 1791 pages, frontmatter validator clean.pnpm lint:navcheck— passes./en/documentation/platform/real-time-events/and confirm the sidebar shows 10 rows: Overview, Quickstart, How it works, Guides and tutorials, Reference (Data sources + GraphQL API fields), Limits, Best practices, Troubleshooting, Glossary, Management./en/documentation/platform/real-time-events/guides/and confirm 11 rows, each with a value in the Type column.pt-brand back — every one of the 19 namespaces pairs./en/documentation/platform/real-time-events/first-steps/and/en/documentation/guides/platform/observability/analyze-navigation-data/are gone fromdist/; both have redirect rows.Notes
Permalink changes, both with redirects in
cicd/massive-redirect/:…/real-time-events/first-steps/→…/real-time-events/quickstart/(en only; the pt-br permalink was alreadyprimeiros-passosand did not move). One older row that pointed at the retired URL was rechained in the same change, so no reader traverses two hops.…/real-time-events/#data-sources→…/real-time-events/data-sources/, written out per language because a fragment target is not localized automatically.Every internal link to both was rewritten, not merely redirected — including 4 absolute
https://www.azion.com/…URLs in the migration guides that a relative-path sweep misses.One guide retired:
analyze-navigation-dataasserted that Real-Time Events provides an Edge Pulse data source. The data-source list has eight entries and none is Edge Pulse, the GraphQL field reference has ten datasets and none is Edge Pulse, and its own variables link pointed at a non-existent anchor. Its content already lives on the Edge Pulse page. Deleted with a redirect, and its 6 inbound links retargeted.Real-Time Events is a Platform Resource, not an Observe product.
azion-kb:company-definitions/product-naming.mdstill lists it under Observe products and needs correcting — any skill run reading it for this resource's class gets the wrong answer.Four variables were documented in Portuguese and never in English, in any version:
Proxy Statuson HTTP Requests, andSourceon Image Processor, Edge DNS and Data Stream. Both languages now carry them, at 129 rows each. Worth confirming they are still real.Not done, and not claimed: the benchmark baseline was never taken, so there is no coverage-gain figure for this rework. The style gate (
.claude/hooks/docs_gate.py) does not exist in this checkout and was not run.Known gap: the CSV export guide cannot say whether the download covers the visible page or the whole result set, and the download control in Console has no label. Both are recorded as owed.