Add search syntax section to Dashboard List docs#37376
Conversation
Document the full query syntax supported by the v2 dashboard search: free-text search, key:value filters, boolean operators, range comparisons, wildcards, quoted phrases, and the Favorites UI toggle.
… entry - Remove Frequently Viewed By You from preset lists (no longer supported) - Add New callout banner to Search syntax section - Add favorites:true to key:value filters table - Remove team: tag note - Remove Favorites UI toggle subsection (replaced by favorites:true syntax)
Preview links (active after the
|
archana-asokan
changed the title
🐑 PR Shepherd is maintaining this PRI watch your PR and automatically fix CI failures, rebase your branch, handle flaky tests, and push it to the merge queue when it's ready. More about what I do → Guide To pause me on this PR, add the |
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Nice addition — the new Search syntax section is well-organized and the tables are easy to scan. A few minor style and clarity suggestions inline; nothing blocking.
Reviewed f51d5cabe99004b10685e9d01d335708aa5290bb — workflow run
| | `description:<value>` | Dashboard description | `description:latency` | | ||
| | `team:<value>` | Team tag | `team:dashboards-backend` | | ||
| | `favorites:true` | Dashboards you have starred | `favorites:true` | | ||
| | `type:<value>` | Dashboard type. Use `custom`, `integration`, or concrete values such as `custom_timeboard`, `custom_screenboard`, `integration_timeboard`, `integration_screenboard`. | `type:integration` | |
There was a problem hiding this comment.
Suggestion: This cell mixes the high-level values (custom, integration) with four concrete values in a long sentence, making the table row hard to scan. Consider splitting into separate rows, or moving the concrete-value list to a short sentence above the table.
| |--------|-------------|---------| | ||
| | `widgets.count:<N` | Fewer than N widgets | `widgets.count:<3` | | ||
| | `widgets.count:>=N` | N or more widgets | `widgets.count:>=10` | | ||
| | `popularity:>=N` | Popularity at or above threshold | `popularity:>=0.2` | |
There was a problem hiding this comment.
Suggestion: This Range operators table largely duplicates the widgets.count and popularity rows already in the Key:value filters table. Consider either removing those rows from the upper table (and pointing readers here for range syntax) or replacing this table with a short prose paragraph that shows the operator forms once, to avoid two sources of truth.
rtrieu
left a comment
rtrieu
left a comment
There was a problem hiding this comment.
some minor feedback for your review
| ## Search syntax | ||
|
|
||
| {{< callout url="#" btn_hidden="true" header="New" >}} | ||
| Dashboard search syntax is available on the updated Dashboard List page. |
There was a problem hiding this comment.
| Dashboard search syntax is available on the updated Dashboard List page. |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
2 participants
What does this PR do? What is the motivation?
Search syntax (new section)
The "Syntax Help" link in the search bar points to an internal Confluence page. This adds the public version: a search syntax section on the Dashboard List docs page covering free-text queries, key:value filters (
author:,team:,favorites:true,type:,widgets.*, and more), boolean/range operators, wildcards, and quoted phrases.All syntax was checked against the actual
dashbooks-search-queryimplementation anddashboards_v3ES index, not the wiki.Preset lists cleanup
Removes "Frequently Viewed By You" — that list is no longer supported.
Merge instructions
Merge readiness:
Additional notes
DEFAULT_SEARCH_HELP_URLto point tohttps://docs.datadoghq.com/dashboards/list/#search-syntax. Merge this first so the anchor is live before the feature flag rolls out.datadog-valestyles repo to run locally — CI will cover it.