[DOCS-XXXXX] Document the team filter and its use as a template variable - #39102
Conversation
Update the team filter documentation to describe the current control: one list covering Datadog Teams and team tag values, pin, shift+click hierarchy modes, search behavior, and device-level persistence. Remove references to favorites, the My Teams label, and the on/off toggle. Document that a template variable on the team tag key renders as the team filter, and add a guide for using it against a different tag key with $team.value. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This comment has been minimized.
This comment has been minimized.
|
Created DOCS-15380 for Docs Team review. |
Recapture the team filter in the Datadog Demo org: the unified control with the pin, the shift+click subteam selection state, and the team template variable on a dashboard. Remove the orphaned screenshot of the old filter. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Replace the My Teams toggle wording on the RUM ownership of views and Infrastructure host list pages with the team filter, and link to it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…-template-variable-docs # Conflicts: # hugo/content/en/real_user_monitoring/ownership_of_views.md
There was a problem hiding this comment.
thank you for the PR! this looks really good. i left some inline suggestions
three things besides the comments
1. deleting teams_filter_hierarchies.png breaks a French page
hugo/static/images/account_management/teams/teams_filter_hierarchies.png is still referenced at hugo/content/fr/account_management/teams/manage.md:68. the English page uses teams_filter_hierarchies2.png, so these are two separate files and the English side is unaffected, but removing this one leaves a broken image on the FR site. simplest fix is to leave the file in place; otherwise the FR change needs to go through localization rather than a hand-edit
2. screenshots
did you want me to take care of that, or were you planning on it? either way is fine with me!
**3. Team tags vs All Teams **
does the ALL TEAMS section contain Datadog Teams you are not a member of,
team tag values with no matching Team, or both?
asking because teams/_index.md:108 describes it as "team tag values found on
your data that have no matching Datadog Team," and a few things in the
screenshots point the other way:
- the section is labeled ALL TEAMS in all three captures, and the page's own
alt text on line 110 calls it "an All Teams section." the body and the alt text
disagree with each other Singapore SEin that section is annotated "1 Subteam." subteams belong to
Datadog Teams, so that row looks like a real Team rather than a tag value- the rows read like Team display names (
[Demo] Caroline H.'s Team, emoji
prefixes) rather than the lowercase-hyphenated handles that the IDP ownership
page in this PR recommends
worth settling before merge because the same claim appears in three files:
teams/_index.md:108, template_variables.md:76, and notebooks/_index.md:193.
it also affects the "Each section of the filter lists up to 50 items" line, since
that depends on what counts as a section
if the section holds both Teams and orphan tag values, the fix may just be using
the UI's label and broadening the description.
please let me know if you want to talk about any of this!
| The team filter works by adding team-based search terms to the search query. After you make a selection, you can see the team-based search terms it adds in the search bar. To stop filtering by team, clear your selection. | ||
|
|
||
| You may be interested in a particular team's resources without being a member of that team. Adding a team to your favorite teams allows you to get filtered views on that team's resources without joining the team. | ||
| Each section of the filter lists up to 50 items, sorted alphabetically. To reach a value beyond that limit, search for it. |
There was a problem hiding this comment.
the All Teams list in team-template-variable.png runs [Caroline], [Demo], [grega], [sblin], Singapore SE, JP-SDR which isn't alphabetical by display name. does it sort by handle? worth saying which, since the search section just below notes that both handle and display name are searched
There was a problem hiding this comment.
Checked this. It sorts alphabetically by display name, case-insensitive, with emoji prefixes ignored for sorting — so [Caroline], [Demo], [grega], [sblin] are ordered on the bracketed prefix, and Singapore SE / JP-SDR fall into a leading group I couldn't account for. Since I can't explain that leading group, I'd rather not commit the docs to a precise rule, so I've left the line general. Happy to tighten it if you'd prefer.
| ### Pin your selection | ||
|
|
||
| #### Add or remove favorite teams | ||
| Pin the team filter to carry your selection to the other pages you open. The pin sits at the top of the team filter and behaves like the time range pin. |
There was a problem hiding this comment.
"behaves like the time range pin" assumes the reader already knows that control. a short definition or a link would be helpful, like "...and carries the selection to other pages the same way the time range pin does."
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Co-authored-by: Olivia Shoup <116908616+OliviaShoup@users.noreply.github.com>
Restore teams_filter_hierarchies.png, which the French Teams page still references. Correct the All Teams description: the section lists Datadog Teams in the organization, not team tag values. Move the Team filter section after Add a template variable, condense the widget query tables and setup steps, and apply alt text, capitalization, and wording fixes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…iable-docs' into tom.nof/team-filter-template-variable-docs # Conflicts: # hugo/content/en/dashboards/template_variables.md
|
/review |
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Content is well-structured and clearly explains the new team filter behavior. A couple of small style/consistency observations below — no blockers.
Reviewed 01e96e771a3b22b1ee5adfc629077e7eded520db — workflow run
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
Thanks for the review — all three settled: 1. FR image. Good catch. Restored 2. Screenshots. I took care of them — captured in the Datadog Demo org. 3. One heads-up on the suggestion-accept flow: your condensed-instructions suggestion ended up applied three times over when it was accepted through GitHub's "Commit suggestion" button. The button only applies the suggestion block, so it couldn't honor your "the two paragraphs above would need deleting alongside it" caveat, and the earlier copies stayed. My merge resolved it and the section reads correctly now — flagging it in case you hit the same thing on other PRs. |
What does this PR do? What is the motivation?
Fixes DOCS-XXXXX
Updates the team filter documentation and documents the team filter as a dashboard and notebook template variable.
Team filter (
account_management/teams/)teamtag values, with all teams in the organization available.Template variables (
dashboards/template_variables.md)teamtag key renders as the team filter, and that hierarchy-aware selection appears only for that tag key. This is the answer to the recurring question of why one dashboard's team filter shows hierarchy and another's does not.team_attribution,attributes.team,usr.team) by defining the variable onteamand referencing$team.valuein widget queries, with before-and-after examples and how multi-select and hierarchy selections resolve.Also updated: dashboard list, notebooks, and IDP catalog ownership pages that referenced the removed My Teams toggle or label.
Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Drafted with Claude Code. Behavior of
$team.valueunder multi-select and hierarchy selection was verified against a live dashboard by inspecting resolved widget queries.Additional notes
Screenshot still needed:
static/images/account_management/teams/team-filter.pngshows the old two-control layout with the My Teams label, per-team toggles, and Add Favorites. It is no longer referenced, but a new capture showing the unified control with the pin and a team tags section would improve the page.