Skip to content

Announce the addition of the Google docs add on to Free & Premium #4603#22309

Merged
JorPV merged 5 commits intotrunkfrom
4603-announce-addition-of-google-docs-addon-to-free-and-premium
Jun 24, 2025
Merged

Announce the addition of the Google docs add on to Free & Premium #4603#22309
JorPV merged 5 commits intotrunkfrom
4603-announce-addition-of-google-docs-addon-to-free-and-premium

Conversation

@mykola
Copy link
Copy Markdown
Contributor

@mykola mykola commented May 27, 2025

Context

  • Announce the addition of the Google docs add on to Free & Premium.

Summary

This PR can be summarized in the following changelog entry:

  • Adds an announcement for the Google Docs add-on.
  • [wordpress-seo-premium] Adds an announcement for the Google Docs add-on.

Relevant technical choices:

  • GoogleDocsAddonUpsell component added to implement this. It Content required to be wrapped in Modal to be displayed correctly. IsPremium at some pages we can take only from wpseoIntroductions object so it's used.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Check that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed in for Free.

  • Deactivate Yoast Premium plugin if it's active.
  • Deactivate the free plugin.
  • Open any sql editor or use wp db query wp-cli command and remove _yoast_wpseo_introductions meta_key from wp_usermeta table:
    DELETE FROM `wp_usermeta` WHERE `meta_key` = '_yoast_wpseo_introductions'
  • Activate the free plugin.
  • Make sure that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed and fit the design:
    image
  • Click on Unlock with Yoast SEO Premium button and make sure that url is opened in new tab (the pages should be created and active before tests).

Check that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed in for Premium.

  • Activate Yoast Premium plugin.
  • Install previous version of Free plugin (or just build from trunk if it's not merged yet)
  • Open any sql editor or use wp db query wp-cli command and remove _yoast_wpseo_introductions meta_key from wp_usermeta table:
    DELETE FROM `wp_usermeta` WHERE `meta_key` = '_yoast_wpseo_introductions'
  • Upgrade free plugin to the current version from this PR.
  • Navigate to Yoast Settings page.
  • Make sure that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed and fit the design:
    image
  • Click on Get started for free button and make sure that url is opened in new tab (the pages should be created and active before tests).

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Should not impact other places.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #4603

@mykola mykola added the UI change PRs that result in a change in the UI label May 27, 2025
@mykola mykola added this to the 25.3 milestone May 27, 2025
@coveralls
Copy link
Copy Markdown

coveralls commented May 27, 2025

Pull Request Test Coverage Report for Build f7e11f5e7b03ab02365894213e6f578f3781e89a

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 3 of 28 (10.71%) changed or added relevant lines in 4 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.02%) to 53.652%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/introductions/initialize.js 0 1 0.0%
packages/js/src/shared-admin/components/google-docs-addon-upsell.js 3 5 60.0%
packages/js/src/introductions/components/content.js 0 10 0.0%
src/introductions/application/google-docs-addon-upsell.php 0 12 0.0%
Files with Coverage Reduction New Missed Lines %
packages/js/src/introductions/initialize.js 1 0.0%
Totals Coverage Status
Change from base Build 3010e3277d95433295cd9d14a28c13715abc6a66: -0.02%
Covered Lines: 30346
Relevant Lines: 57579

💛 - Coveralls

@mykola mykola marked this pull request as ready for review May 27, 2025 07:04
@hannaw93 hannaw93 removed this from the 25.3 milestone May 27, 2025
@JorPV JorPV added innovation Innovative issue. Relating to performance, memory or data-flow. changelog: other Needs to be included in the 'Other' category in the changelog and removed innovation Innovative issue. Relating to performance, memory or data-flow. labels Jun 20, 2025
@JorPV
Copy link
Copy Markdown
Contributor

JorPV commented Jun 20, 2025

@mykola the Learn more -> link is visible in the modal, but I don't see it in the design. Was it something decided later on?

image

Comment thread packages/js/src/introductions/components/content.js
Comment thread packages/js/src/introductions/initialize.js
Comment thread packages/js/src/shared-admin/components/google-docs-addon-upsell.js Outdated
Comment thread packages/js/src/shared-admin/components/google-docs-addon-upsell.js Outdated
Comment thread packages/js/src/shared-admin/components/google-docs-addon-upsell.js Outdated
* @param {string} buttonLabel The button label.
* @param {string} newToText The new to text.
* @param {string|JSX.Element} bundleNote The bundle note.
* @param {string} ctbId The click to buy to register for this upsell instance.
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 same for ctbId, it isn't really clear to me. Maybe something more specific like:

"The upgrade button data-ctb-id to register for this upsell instance"

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.

@JorPV this dialog is reused from previous one so it has the same structure. I have removed unused elements.

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.

Thanks @mykola But if you update the prop, the param should also much the prop definition. And please also add the param for the isPremium prop.

@param {string} productName The product name.
@param {boolean} isPremium Whether the user has a premium license.

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.

Hi @mykola,

Please note that the props and the params still don't match. While you updated productName and isPremium in the props, the params still aren't updated.

target="_blank"
ref={ initialFocus }
data-action="load-nfd-ctb"
data-ctb-id={ ctbId }
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.

Will this value ever change? Otherwise, I would assign it in here instead of passing it as a prop.

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.

It's from reused dialog. It's something that is used for analytics so I'm not sure that it's should be changed or removed. So I live it as is just in case if it's required.

}

/**
* Returns the name of the introdyction.
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.

There is a typo in introduction 😄

@JorPV JorPV added this to the 25.5 milestone Jun 20, 2025
Copy link
Copy Markdown
Contributor

@JorPV JorPV left a comment

Choose a reason for hiding this comment

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

CR some small changes proposed.
AT Free ✅
AT Premuim ❌ As soon as I delete the table row in the database, the free upsell modal appears before activating the Premium plugin.

Copy link
Copy Markdown
Contributor

@JorPV JorPV left a comment

Choose a reason for hiding this comment

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

I've just pushed a minor adjustment in the params for the GoogleDocsAddonUpsell component.

@JorPV
Copy link
Copy Markdown
Contributor

JorPV commented Jun 24, 2025

CR ✅
AT ✅

@JorPV JorPV merged commit e07a250 into trunk Jun 24, 2025
35 of 36 checks passed
@JorPV JorPV deleted the 4603-announce-addition-of-google-docs-addon-to-free-and-premium branch June 24, 2025 12:12
@bethemma
Copy link
Copy Markdown
Contributor

bethemma commented Jul 2, 2025

A bit late but here are the links @mykola

Upsell UTM for free is https://yoa.st/gdocs-free
Upsell UTM for premium is https://yoa.st/gdocs-premium

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: other Needs to be included in the 'Other' category in the changelog UI change PRs that result in a change in the UI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants