Skip to content

Premium Analytics: remove the page descriptions and the section header date subtitle - #51707

Merged
retrofox merged 5 commits into
trunkfrom
update/remove-analytics-page-descriptions
Aug 31, 2026
Merged

retrofox merged 5 commits into
trunkfrom
update/remove-analytics-page-descriptions

Conversation

@retrofox

@retrofox retrofox commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Fixes WOOA7S-2027

Proposed changes

This removes them from the three places they rendered, along with the plumbing that only existed to carry them.

  • Report pages: the subTitle each page passed to ReportPageShell, and the getDescription entries in the report registry, which nothing read.
  • Dashboard: the per-section description rendered as the Page subtitle above the tab bar. The field comes out of the section registration, the Dashboard_Section model, the REST schema and the DashboardSection type, so a section can no longer register one. The distinct section title (Site traffic for the Traffic tab) stays.
  • Section header: the subtitle describing the applied date configuration (Tuesday, July 21 – Monday, July 27 (7 days, daily) vs. …). The recap moves the exact range to a tooltip on the date controls, so the header keeps the title and the controls only, and getSectionSubtitle goes with it. condenseOnScroll still steps the title down a size once the header pins; there is no row left to collapse.

This undoes the description half of #51092 and the subtitle from #50897. formatDateRangeLong and getDateRangeSpan stay in @jetpack-premium-analytics/formatters for the tooltips WOOA7S-2024 and WOOA7S-2028 add.

Until those tooltips land, the compared period is readable only by its preset name on the comparison control, and the active chart interval only from the interval menu.

Screenshots

Dashboard, Traffic tab:

Before After
image image

Reports page:

Before After
image image

Related product discussion/links

  • Linear: WOOA7S-2027, in the "Jetpack Stats v2: Revised date range picker" project.
  • Eder's 26 August recap on the Unified Analytics P2, under "Other adjustments": "Remove all the page descriptions. We want to reduce noise as much as possible."

Does this pull request change what data or activity we track or use?

No.

Testing instructions

  • Build the package: jetpack build --deps packages/premium-analytics.
  • Open Stats (admin.php?page=jetpack-premium-analytics-wp-admin). Under the Stats page title there is no description on any tab. Each section header shows its title and the date controls, with no date range line under the title, and still condenses into the compact bar as you scroll.
  • Open a report page (All pages, Emails, Videos, Tags & categories, All comments, Annual insights). The page header has no description under the breadcrumbs, and the section header carries the title and the range picker only.
  • GET /wp-json/wpcom/v2/dashboards/analytics/sections returns no description key on any section.
  • Storybook: Packages/Premium Analytics/UI/SectionHeader renders every story without a subtitle, and Packages/Premium Analytics/Routes/Dashboard/SectionsGrid shows no page description.

@retrofox
retrofox requested a review from a team as a code owner August 28, 2026 10:53
@retrofox retrofox added Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review This PR is ready for review. labels Aug 28, 2026
@retrofox retrofox self-assigned this Aug 28, 2026
@github-actions

github-actions Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack or WordPress.com Site Helper), and enable the update/remove-analytics-page-descriptions branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack update/remove-analytics-page-descriptions
bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/remove-analytics-page-descriptions

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions

github-actions Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: September 7, 2026

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Premium Analytics plugin:

No scheduled milestone found for this plugin.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Nikschavan
Nikschavan previously approved these changes Aug 28, 2026

@Nikschavan Nikschavan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, the changes look good. I left one question inline about the chart interval.

subtitle={ sectionSubtitle }
condenseOnScroll
>
<SectionHeader title={ resolveSectionHeading( section ) } condenseOnScroll>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the subtitle gone, the active bucket is no longer readable without opening the interval menu: the trigger is a glyph and its accessible name is the fixed Chart interval (date-interval-dropdown.tsx#L66). WOOA7S-2024 and WOOA7S-2028 cover the period and the comparison tooltips, but neither names the interval. Is there a ticket for it, or would folding the current value into the trigger label cover it for now?

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.

No ticket covers it. Going through the WOOA7S-1793 children: 2024 is the period tooltip, 2028 the comparison one, and 2026 is what moved the interval behind the button in the first place. None of them names the active bucket.

The design does treat the interval as secondary on purpose: the 26 August recap asks it to "always default to a recommended option based on the selected range, only needed if users want to adjust it", and that default already ships. getAllowedIntervalsByRange() returns the buckets a range allows, default first, and several ranges allow exactly one, so there the control has nothing to choose.

What is not intentional is the asymmetry you are pointing at: the period and the comparison each get their exact value on a tooltip, and the interval gets nothing. So yes, folding the value into the trigger label covers it. IconButton's label renders both as the tooltip and as the accessible name, so Chart interval: Days gives the interval the same hover surface its two siblings get, with no text back on the face.

I'll do it in #51708, which already rewrites that trigger onto the design system Menu and renames the buckets to Days / Weeks / Months, which composes better into that string. Keeping it out of this PR so the two don't collide.

@jp-launch-control

Copy link
Copy Markdown

Code Coverage Summary

Coverage changed in 6 files. Only the first 5 are listed here.

File Coverage Δ% Δ Uncovered
projects/packages/premium-analytics/packages/datetime/src/presets/comparison.ts 8/10 (80.00%) -20.00% 2 ❤️‍🩹
projects/packages/premium-analytics/packages/widgets-toolkit/src/components/report-page/report-page-layout.tsx 2/2 (100.00%) 0.00% 0 💚
projects/packages/premium-analytics/routes/dashboard/stage.tsx 35/40 (87.50%) -1.63% 0 💚
projects/packages/premium-analytics/src/class-dashboard-section.php 48/48 (100.00%) 0.00% 0 💚
projects/packages/premium-analytics/src/dashboard-sections.php 201/207 (97.10%) -0.13% 0 💚

Full summary · PHP report · JS report

@retrofox
retrofox merged commit c8de65e into trunk Aug 31, 2026
81 checks passed
@retrofox
retrofox deleted the update/remove-analytics-page-descriptions branch August 31, 2026 09:31
@github-actions github-actions Bot added [Status] UI Changes Add this to PRs that change the UI so documentation can be updated. and removed [Status] Needs Review This PR is ready for review. labels Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Package] Premium Analytics [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Premium Analytics [Status] UI Changes Add this to PRs that change the UI so documentation can be updated. [Tests] Includes Tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants