Feature Description

Further to this Slack thread and this discussion, all documentation/support links for Email Reporting/Proactive User Enhancement need to be updated with actual links instead of placeholder support links.

Complete Link Inventory

All learn more, get help, and documentation links across the PUE/Email Reporting feature:

Frontend — Admin UI

Backend — Email Templates

All email types (report, subscription confirmation, invitation, error) now use a single simple email template with a shared footer rendered by parts/footer.php.

Doc Key Mapping

Note: some of these keys may not be used in the final docs.

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• All support documentation links within the Email Reporting feature should link to one of the above doc key maps across:
  • Plugin components
  • Email templates

Implementation Brief

Frontend: Admin Settings

• Update file assets/js/components/settings/SettingsEmailReporting.js
  • Remove the TODO comment on line 264 (/** TODO update learn more link when it is provided. */) since the email-reporting doc key is now the intended destination

Frontend: Invite Panel

• Update file assets/js/components/email-reporting/InviteOthersToSubscribe/index.js
  • Change getDocumentationLinkURL( 'email-reporting' ) (line 120) to getDocumentationLinkURL( 'email-reporting-inviting-others' )

Frontend: Error Notices (side panel + admin settings)

• Update file assets/js/components/email-reporting/notices/errors/ReportErrorNotice.js

  • Change getDocumentationLinkURL( 'email-reporting' ) to getDocumentationLinkURL( 'email-reporting-module-issues' )

• Update file assets/js/components/email-reporting/notices/errors/SendingErrorNotice.js

  • Import useSelect and CORE_SITE
  • Add getDocumentationLinkURL( 'email-reporting-deliverability-issues' ) selector
  • Add useNotificationEvents tracking (import already present)
  • Add a dismissButton with "Get help" label linking to the doc URL (follow ReportErrorNotice.js pattern)

• Update file assets/js/components/email-reporting/notices/errors/CronSchedulerErrorNotice.js

  • Import useSelect and CORE_SITE
  • Add getDocumentationLinkURL( 'email-reporting-scheduler-issues' ) selector
  • Add a dismissButton with "Get help" label linking to the doc URL

• Update file assets/js/components/email-reporting/notices/errors/ServerErrorNotice.js

  • Import useSelect and CORE_SITE
  • Add getDocumentationLinkURL( 'email-reporting-server-issues' ) selector
  • Add a dismissButton with "Get help" label linking to the doc URL

Backend: Email Templates

All email types now use a single simple email template with a shared footer in templates/parts/footer.php. Footer "Help center" link (?doc=get-support) is hardcoded in the shared footer — no changes needed there.

• Update file includes/Core/Email_Reporting/Email_Template_Formatter.php

  • In prepare_subscription_confirmation_template_data() (line 395), replace hardcoded 'https://sitekit.withgoogle.com/documentation/email-reports/' with add_query_arg( 'doc', 'email-reporting', 'https://sitekit.withgoogle.com/support/' )

• Update file includes/Core/Email_Reporting/REST_Email_Reporting_Controller.php

  • In invitation email data (line 583), replace hardcoded 'https://sitekit.withgoogle.com/documentation/email-reports/' with add_query_arg( 'doc', 'email-reporting', 'https://sitekit.withgoogle.com/support/' )

• Update file includes/Core/Email_Reporting/Batch_Error_Notifier.php

  • In get_body_args() (line 315), replace the single generic $help_url (doc=email-reporting) with specific URLs per content key:
    • error-email-report-search-console and error-email-report-analytics-4 ... doc=email-reporting-module-issues
    • error-email-permissions-search-console ... error_id=search-console_insufficient_permissions (matching the frontend PermissionsErrorNotice pattern)
    • error-email-permissions-analytics-4 ... error_id=analytics-4_insufficient_permissions

Test Coverage

• Update JS tests for ReportErrorNotice to verify the "Get help" link uses the email-reporting-module-issues doc key
• Update JS tests for SendingErrorNotice, CronSchedulerErrorNotice, and ServerErrorNotice to verify the "Get help" link renders with the correct doc URL
• Update InviteOthersToSubscribe tests to verify the updated email-reporting-inviting-others doc key
• Update Batch_Error_Notifier PHP tests to verify the email-reporting-module-issues doc slug in error email body args

QA Brief

• Confirm every Learn more or documentation link in the email reporting feature, notices and emails links to the email reporting documentation.
• Confirm every Learn more or documentation link maps to the correct document key specified in the ticket description.

Changelog entry

• Add documentation links to Email Reporting feature.