[WIP] Fix stale/incorrect content across existing DO docs#37964
Draft
kevinzenghu wants to merge 1 commit into
Draft
[WIP] Fix stale/incorrect content across existing DO docs#37964kevinzenghu wants to merge 1 commit into
kevinzenghu wants to merge 1 commit into
Conversation
Found via a proactive quality audit of already-published pages (not a gap-finding pass — these are corrections to live content). All are mechanical/verifiable, not judgment calls: - databricks.md: GRANT USE_CATALOG/USE_SCHEMA is invalid Unity Catalog syntax (underscored) — would fail if copy-pasted. Correct two-word form (GRANT USE CATALOG/SCHEMA) is already used correctly earlier in the same file and consistently in the sibling jobs_monitoring/databricks/_index.md page. Fixed all 5 occurrences. - 5 pages (snowflake/redshift/bigquery/aws_glue x2/glue) still linked to the old app.datadoghq.com/datasets/... URL scheme; updated to the current /data-obs/... scheme already used consistently elsewhere (e.g. dbt.md, data_catalog.md, monitors/types/data_observability.md). - 3 pages (emr.md, airflow.md, databricks/_index.md) used the old "DJM" acronym in body text instead of "Jobs Monitoring", used everywhere else. - data_catalog.md called the monitor feature "Data Quality Monitors"; every other page (monitors/types/data_observability.md and all warehouse/data-lake pages) calls it "Data Observability monitors". - jobs_monitoring/_index.md's two card-grid blocks mixed legacy /data_jobs/* alias paths with the canonical /data_observability/ jobs_monitoring/* form used elsewhere on the same page; standardized to canonical. (Left the AWS Glue card's neighboring position alone — a separate open PR, #37962, adds an Azure Data Factory card to this same file; whichever merges second will need a quick rebase.) - Removed 3 dangling reference-link definitions (dataproc.md, emr.md, looker.md) never cited in body text — harmless but leftover cruft. Not touched (need product input, not a mechanical fix): - A split between app.datadoghq.com/data-jobs/ (used almost everywhere) and .../data-obs/jobs (used in the newest jobs_monitoring page) — lower confidence on which is canonical; flagging for the product team rather than guessing. - An oddly-named image asset (entity_type_selection_and_aastra.png) — cosmetic only, the file exists and renders fine. AI assistance: found and fixed by Claude Code via a systematic audit against sibling-page conventions within the same doc tree — each fix is independently verifiable by diffing against the correct pattern cited above, not a judgment call.
Contributor
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
1 participant
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
Found via a proactive quality audit of already-published DO docs (not gap-finding — corrections to live content). All are mechanical/verifiable against sibling-page conventions, not judgment calls.
Fixes
databricks.mduses invalid Unity Catalog syntax (GRANT USE_CATALOG/USE_SCHEMA, underscored) in 5 places — would fail if copy-pasted. Corrected to the two-word form already used correctly elsewhere in the same file and consistently in the sibling Jobs Monitoring Databricks page.app.datadoghq.com/datasets/...scheme; updated to the current/data-obs/...scheme used everywhere else.jobs_monitoring/_index.md's card-grid hrefs to the canonical path form.Cross-PR note
jobs_monitoring/_index.mdis also touched by #37962 (adds an Azure Data Factory card to the same card-grid). Whichever of these two merges second will need a quick rebase — flagging so it's not a surprise.Deliberately not touched
app.datadoghq.com/data-jobs/(used almost everywhere) and.../data-obs/jobs(used in the newest page) — lower confidence on which is canonical, flagging for the product team instead of guessing.Status
Work in progress — not ready for review yet. Draft, no reviewers requested.
AI assistance
Found and fixed by Claude Code via systematic audit against sibling-page conventions — each fix is independently verifiable by diffing against the cited correct pattern, not a judgment call. Flagging per the AI-assistance disclosure in CONTRIBUTING.md.