Skip to content

[DOCS-XXXXX] Document the team filter and its use as a template variable - #39102

Merged
OliviaShoup merged 16 commits into
masterfrom
tom.nof/team-filter-template-variable-docs
Sep 2, 2026
Merged

[DOCS-XXXXX] Document the team filter and its use as a template variable#39102
OliviaShoup merged 16 commits into
masterfrom
tom.nof/team-filter-template-variable-docs

Conversation

@tomnof

@tomnof tomnof commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

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/)

  • Rewrites the team filter section to describe the current control: one list covering both Datadog Teams and team tag values, with all teams in the organization available.
  • Removes documentation for functionality that no longer exists: favoriting a team to expand filter scope, the My Teams label, and the on/off toggle.
  • Adds pin behavior, including that pinned selections are stored per browser and per device, and deep-link behavior.
  • Adds shift+click selection modes for choosing a team without its subteams, or its subteams without the team.
  • Adds search behavior: case-insensitive substring matching against handle and display name, with double quotes for exact matches.
  • Replaces the stale screenshot with the current one. A fresh capture is still needed (see below).

Template variables (dashboards/template_variables.md)

  • Documents that a template variable on the team tag 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.
  • Adds a guide for using the team filter against a different tag key (team_attribution, attributes.team, usr.team) by defining the variable on team and referencing $team.value in 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

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <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.
  • 🤖 New: Comment with /review to 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.value under 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.png shows 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.

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>
@tomnof
tomnof requested a review from a team as a code owner August 11, 2026 16:42
@datadog-datadog-prod-us1

This comment has been minimized.

@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label Aug 11, 2026
@drichards-87

Copy link
Copy Markdown
Collaborator

Created DOCS-15380 for Docs Team review.

@jhgilbert jhgilbert added the astro-reorg-no-conflicts Needs manual conflict resolution after replatforming reorg label Aug 11, 2026
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>
@github-actions github-actions Bot added the Images Images are added/removed with this PR label Aug 11, 2026
tomnof and others added 2 commits August 12, 2026 09:40
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

@OliviaShoup OliviaShoup left a comment

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.

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 SE in 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!

Comment thread hugo/content/en/account_management/teams/_index.md Outdated
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.

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.

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

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.

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.

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.

"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."

Comment thread hugo/content/en/account_management/teams/_index.md Outdated
Comment thread hugo/content/en/account_management/teams/_index.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md
Comment thread hugo/content/en/real_user_monitoring/ownership_of_views.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md Outdated
tomnof and others added 11 commits August 13, 2026 02:40
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
@OliviaShoup

Copy link
Copy Markdown
Contributor

/review

@OliviaShoup OliviaShoup self-assigned this Aug 20, 2026

@github-actions github-actions Bot left a comment

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.

🤖 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 01e96e771a3b22b1ee5adfc629077e7eded520dbworkflow run

Comment thread hugo/content/en/account_management/teams/_index.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md Outdated
Comment thread hugo/content/en/account_management/teams/_index.md Outdated
Comment thread hugo/content/en/dashboards/template_variables.md Outdated
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@tomnof

tomnof commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review — all three settled:

1. FR image. Good catch. Restored teams_filter_hierarchies.png; the FR page is untouched so any change there can go through localization.

2. Screenshots. I took care of them — captured in the Datadog Demo org.

3. ALL TEAMS. You were right, and my original description was wrong. That section holds Datadog Teams in the org, including ones you're not a member of — not orphan tag values. The subteam counts and display names you spotted were the giveaway. The filter now documents three sections: your teams, All Teams, and team tags (the orphan team tag values, which do get their own section). Body and alt text agree now, and I corrected the same claim in template_variables.md and notebooks/_index.md. The 50-item line still holds — it's per section.

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.

@OliviaShoup
OliviaShoup merged commit da105be into master Sep 2, 2026
27 of 28 checks passed
@OliviaShoup
OliviaShoup deleted the tom.nof/team-filter-template-variable-docs branch September 2, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

astro-reorg-no-conflicts Needs manual conflict resolution after replatforming reorg editorial review Waiting on a more in-depth review Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants