Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Excludes image captions inside classic blocks from the keyphrase in introduction assessment #21564

Conversation

FAMarfuaty
Copy link
Contributor

@FAMarfuaty FAMarfuaty commented Aug 26, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where an image caption inside a classic block would be considered the introduction when using the keyphrase in introduction assessment in the default editor.
  • [yoastseo enhancement] Excludes the image caption inside a classic block from the keyphrase in introduction assessment.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

AI Optimize

Block editor, classic block

  • Create a post in Block editor
  • Set a keyphrase
  • Add one classic block
  • To the classic block, add a text with more than 300 words, make sure to add the keyphrase in the first paragraph and don't add the keyphrase anywhere else
  • Go to the keyphrase in introduction assessment
  • Confirm that the assessment returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment recognizes one keyphrase occurrence
  • Inside the classic block, before the first paragraph, add an image with a caption that doesn't include the keyphrase
  • Confirm that the keyphrase in introduction assessment still returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment still recognizes one keyphrase occurrence
  • Add the keyphrase to the image caption
  • Confirm that the keyphrase in introduction assessment still returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment now recognizes two keyphrase occurrences

Classic editor

  • Create a post in Classic editor
  • Set a keyphrase
  • Add a text with more than 300 words, make sure to add the keyphrase in the first paragraph and don't add the keyphrase anywhere else
  • Go to the keyphrase in introduction assessment
  • Confirm that the assessment returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment recognizes one keyphrase occurrence
  • Before the first paragraph, add an image with a caption that doesn't include the keyphrase
  • Confirm that the keyphrase in introduction assessment still returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment still recognizes one keyphrase occurrence
  • Add the keyphrase to the image caption
  • Confirm that the keyphrase in introduction assessment still returns with 🟢 green feedback
  • Go to the keyphrase density assessment
  • Confirm that the keyphrase density assessment now recognizes two keyphrase occurrences

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:

  • No further impact.

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 https://github.com/Yoast/plugins-automated-testing/issues/1814

@FAMarfuaty FAMarfuaty added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Aug 27, 2024
@FAMarfuaty FAMarfuaty marked this pull request as ready for review August 27, 2024 08:35
@FAMarfuaty FAMarfuaty added this to the 23.4 milestone Aug 27, 2024
Copy link
Contributor

@mhkuu mhkuu left a comment

Choose a reason for hiding this comment

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

LGTM! 👍 Thanks for adding an additional unit test! 🙏

@mhkuu
Copy link
Contributor

mhkuu commented Aug 27, 2024

ACC: Works! 🎉

@mhkuu mhkuu merged commit 2c7824a into release/23.4 Aug 27, 2024
16 checks passed
@mhkuu mhkuu deleted the 1814-major-234-ai-block-validation-error-for-keyphrase-intorduction-assessment-while-first-block-is-classic-block branch August 27, 2024 10:15
@mhkuu mhkuu changed the title exclude image caption inside classic block from keyphrase in intro assessment Excludes image captions inside classic blocks from the keyphrase in introduction assessment Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants