Skip to content

[DPS-XXXX] Event spec validation metrics - #1947

Merged
Gleb Lobov (gleb-lobov) merged 4 commits into
mainfrom
feature/event-spec-validation-console-docs
Sep 22, 2026
Merged

Gleb Lobov (gleb-lobov) merged 4 commits into
mainfrom
feature/event-spec-validation-console-docs

Conversation

@gleb-lobov

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions

Copy link
Copy Markdown
Contributor

Missing SEO metadata

The following markdown files are missing required metadata fields:

  • release-notes/event-specification-validation-results-in-console/index.md: missing fields: keywords, sidebar_label

Required fields

The file metadata is important for SEO and marketing. All markdown files, except for those with filenames starting with _, should include:

  • title: Full, descriptive page title
  • sidebar_label: Short title for navigation sidebar (can be the same as the main title)
  • description: One to two sentences summarizing the page contents
  • keywords: Array of marketing/SEO keywords

Please add the missing metadata.

@claude

claude Bot commented Sep 17, 2026

Copy link
Copy Markdown

Style review

Solid, well-structured addition overall: the new data-quality page follows description → categories → per-view sections, stays within four H2s, precedes every heading and table with prose, uses imperative sentence-case headings, links out to Fundamentals instead of re-explaining, and has descriptive alt text on every image. Frontmatter is complete on the docs page and matches release-notes/_README.md on the release note. All internal links and anchors in the diff resolve, and no external URLs were added.

A few things worth fixing.

1. Garden-path sentence and past tense in the category intro

docs/event-studio/tracking-plans/data-quality/index.md:16

Console sorts every event that the pipeline associated with a published event specification into one of four categories:

The reader hits "the pipeline associated" and expects "associated X with Y", so the sentence has to be re-parsed. The past tense also conflicts with the style guide's "stay in the present tense" rule. Suggest:

Console sorts every event that the pipeline matches to a published event specification into one of four categories:

2. Non-parallel list of the four categories

docs/event-studio/tracking-plans/data-quality/index.md:5 (frontmatter description) and docs/event-studio/tracking-plans/index.md:26

how many of them were valid, inferred, had violations, or failed

"were valid, inferred, had violations" breaks the parallel — "were" doesn't carry over to "had violations". Suggest "were valid or inferred, had violations, or failed" in both places.

3. Category names are inconsistent across the PR

The new page establishes the canonical set: "valid events, inferred events, events with violations, and failed events". Several other places shorten it differently, e.g. docs/event-studio/event-catalog/index.md:34:

split into valid, inferred, violations, and failed events

This mixes adjectives and nouns ("violations ... events"). The same shortened form appears in the release note description and in a couple of the new alt texts. Where the full names don't fit, "split by category" plus the link to the data quality page reads better than a half-abbreviated list. Worth picking one form and using it everywhere.

4. "decides" and "Failed events counts"

docs/event-studio/tracking-plans/data-quality/index.md:39

The Data quality rules button in the page header decides whether events that fail validation count as events with violations or as failed events.

A button doesn't decide; "controls whether" or "determines whether" is more precise.

Also :29: "Failed events counts come from…" → "Failed event counts come from…".

5. Event Catalog Volume cell is overloaded

docs/event-studio/event-catalog/index.md:34 — every other cell in that table is a short noun phrase; this one is now two sentences plus a link, which throws off the table. Suggest trimming to something like:

The number of events collected in the last 30 days on the selected pipeline, split by category. See Monitor tracking plan data quality in Console

…or moving the "See" sentence into the prose above the table.

6. Pipeline selector bullet: punctuation and UI bolding

docs/event-studio/event-catalog/index.md:45

  • Pipeline selector: choose the pipeline for the volume and last seen columns. It defaults to your production pipeline

Two issues. The style guide's list rule is "no period at the end unless the item contains multiple sentences" — this has two sentences and no final period, unlike its single-sentence siblings. And the column names aren't bolded here, while the new data-quality page bolds Volume and Last seen as UI elements (CLAUDE.md: bold for UI elements). Suggest collapsing to one clause:

  • Pipeline selector: choose the pipeline used for the Volume and Last seen columns; it defaults to your production pipeline

7. Release note date is a day ahead

release-notes/event-specification-validation-results-in-console/index.md:4 uses date: "2026-09-18" while the docs page uses 2026-09-17. Intentional (scheduled publish), or a typo?

Minor / optional

  • Raw <img> in the release note. Line 15 uses <img src={require('./images/data-quality-panel.png').default} …>; every other release note in the directory uses markdown ![alt](images/…). Fine to keep if the maxWidth: 496px constraint matters, otherwise match the convention.
  • Duplicated image binaries. data-quality/images/event-catalog-volume.png is byte-identical to event-catalog/images/event-catalog-overview.png, and data-quality/images/tracking-plan-data-quality.png is byte-identical to create-and-manage/images/tracking-plan-overview.png. Referencing the existing files with a relative path would avoid two copies drifting out of sync.
  • Drive-by: the line you touched at event-specification-inference/index.md:18 ends "in the Console" — the style guide says Console takes no article. The rest of that file has the same pattern, so it's pre-existing and out of scope; just easy to fix on a line you're already editing.

@gleb-lobov

Copy link
Copy Markdown
Contributor Author

Raw in the release note. Line 15 uses <img src={require('./images/data-quality-panel.png').default} …>; every other release note in the directory uses markdown alt. Fine to keep if the maxWidth: 496px constraint matters, otherwise match the convention.

This is odd, but looks like it's the only one way to not blow up the image to be way too big

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation 467f9db Commit Preview URL

Branch Preview URL
Sep 22 2026, 08:27 AM


Failed event counts come from your [data quality dashboard](/docs/monitoring/index.md), not from the Console API. They are available when the selected pipeline loads failed events into your warehouse, the data quality dashboard is connected to that pipeline, and you have permission to view it. Otherwise the failed events category shows N/A, volumes exclude failed events, and a warning icon next to the volume explains why.

## View data quality for a tracking plan

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tracking plan => Tracking Plan
please double check in other parts too

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually no, we call them lower case. I prefer the entities to be capitalized, but this is not what we are doing in general

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

look here please "What is a Tracking Plan"

https://docs.snowplow.io/docs/fundamentals/tracking-plans/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I checked more probably the example I provided should be changed too to lower case... anyway, maybe claude can do it for us

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I approve so I do not block you, but fix (if not done ready)
warning:
Missing SEO metadata

plus revise the capitalization in the headers to make it consistent with the rest

@gleb-lobov

Copy link
Copy Markdown
Contributor Author

LGTM, I approve so I do not block you, but fix (if not done ready)
warning:
Missing SEO metadata

I've addressed it already

@gleb-lobov

Copy link
Copy Markdown
Contributor Author

plus revise the capitalization in the headers to make it consistent with the rest

I think it already is consistent with the CLAUDE.md

CLAUDE.md, line 28: "Not proper nouns: entities, events, schemas, data structures, tracking plans"

@gleb-lobov
Gleb Lobov (gleb-lobov) merged commit c7b49b6 into main Sep 22, 2026
7 checks passed
@gleb-lobov
Gleb Lobov (gleb-lobov) deleted the feature/event-spec-validation-console-docs branch September 22, 2026 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants