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

Convert Sentence length and paragraph length to use HTML parser and enable AI button for both assessments #21866

Open
wants to merge 16 commits into
base: trunk
Choose a base branch
from

Conversation

FAMarfuaty
Copy link
Contributor

@FAMarfuaty FAMarfuaty commented Nov 27, 2024

Context

  • We want to convert the paragraph length and sentence length assessments to use HTML Parser for the following reasons:
    • To improve the robustness of the assessments' analysis processing
    • To improve the accuracy of the highlighting
    • To make it possible to output the client ID of the blocks that are long or the blocks that contain long sentences
      • This is especially necessary for implementing the Yoast AI Optimize for both assessments

Summary

This PR can be summarized in the following changelog entry:

  • [yoastseo] Converts sentence length and paragraph length assessments to use HTML parser in their analysis.
  • [yoastseo] Converts sentence length and paragraph length assessments highlighting approach from search and replace to position-based approach.
  • [yoastseo] Enables Yoast AI Optimize button for sentence length and paragraph length assessments.
  • Introduces more robust HTML processing and highlighting for the sentence length and paragraph length assessments.
  • [shopify-seo] Introduces more robust HTML processing and highlighting for the sentence length and paragraph length assessments.

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:

Optimize AI button in Free

  • Install and activate Yoast SEO
  • Go through the steps as described in this scenario
    for sentence length and paragraph length assessments
  • Confirm that you get the expected result

For the scenarios below, also install and activate Yoast SEO Premium. If building the plugin, pair this PR with this PR in Premium: https://github.com/Yoast/wordpress-seo-premium/pull/4527

Paragraph length assessment

  • Follow the testing steps as described in this document to test the paragraph length analysis
  • Run the test in WordPress and in Shopify

Sentence length assessment

  • Follow the testing steps as described in this document to test the sentence length analysis
  • Run the test in WordPress and in Shopify

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 other than what is already covered in the testing instructions.

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/lingo-other-tasks/issues/114
Fixes https://github.com/Yoast/lingo-other-tasks/issues/471
Fixes https://github.com/Yoast/wordpress-seo-premium/issues/4524

@FAMarfuaty FAMarfuaty changed the title Html parser/paragraph length Convert Sentence length and paragraph length to use HTML parser and enable AI button for both assessments Nov 27, 2024
@FAMarfuaty FAMarfuaty added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label Dec 17, 2024
@FAMarfuaty FAMarfuaty added innovation Innovative issue. Relating to performance, memory or data-flow. Shopify This PR impacts Shopify. labels Dec 18, 2024
@FAMarfuaty FAMarfuaty marked this pull request as ready for review December 18, 2024 17:00
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.

CR: Looks great, nice to see all this simplified code 😸

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog innovation Innovative issue. Relating to performance, memory or data-flow. Shopify This PR impacts Shopify.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants