[WIP] Add Optimizer (query and job recommendations) documentation#37961
Draft
kevinzenghu wants to merge 2 commits into
Draft
[WIP] Add Optimizer (query and job recommendations) documentation#37961kevinzenghu wants to merge 2 commits into
kevinzenghu wants to merge 2 commits into
Conversation
Optimizer had a full customer-facing surface (JobsRecommendationsPage, per-job/cluster recommendation side panels, a public /api/ui/data-observability-optimizer/recommendations API with a FOR_REVIEW/REVIEWED/IGNORED/RESOLVED status lifecycle, and a "Fix with Bits" AI-assisted-fix action) but zero public documentation, despite being alluded to in the top-level DO overview page's "Optimize cost & performance" bullet. Marked Preview per the DO Product Features tracker: individual recommenders (Snowflake, Databricks SQL, Trino) are gated behind their own feature flags plus a Balto org allowlist, and notifications are separately gated off by default. Deliberately did not claim a specific top-level navigation breadcrumb — confirmed evidence shows recommendations surface inline in Jobs Monitoring job/cluster tables via a side panel (RecommendationsSidePanel, RecommendationsSection), not a fully independent standalone page reachable from primary nav. Flagged as an open item to verify the exact entry point against the live product. AI assistance: drafted by Claude Code, grounded in data-observability-optimizer (backend) and the data-jobs app's Recommendations components (frontend).
Contributor
Preview links (active after the
|
Same class of bug just found and fixed for Airbyte: this PR's new top-level page and its _index.md nextlink were correctly added, but the separate sidebar-nav config (config/_default/menus/main.en.yaml) was not — this branch predates discovering that file exists. Added a top-level entry as a sibling of Quality Monitoring / Jobs Monitoring.
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
Evidence
data-observability-optimizer— public API (/api/ui/data-observability-optimizer/recommendations, list/detail/status-update), FOR_REVIEW→REVIEWED→IGNORED→RESOLVED lifecycle.web-ui/packages/apps/data-jobs/.../JobsRecommendationsPage,RecommendationsSidePanel,RecommendationsSection— confirmed a real UI surface, not just a backend system.Open items
Status
Work in progress — not ready for review yet. Draft, no reviewers requested.
AI assistance
Content drafted by Claude Code, grounded in the cited backend API and frontend components — flagging per the AI-assistance disclosure in CONTRIBUTING.md.