Skip to content

Adds the possibility to add options to the Inclusive language assessor.#19360

Merged
FAMarfuaty merged 3 commits intotrunkfrom
PC-976-adapt-inclusive-language-shortlinks-for-shopify
Dec 9, 2022
Merged

Adds the possibility to add options to the Inclusive language assessor.#19360
FAMarfuaty merged 3 commits intotrunkfrom
PC-976-adapt-inclusive-language-shortlinks-for-shopify

Conversation

@hansjovis
Copy link
Copy Markdown
Contributor

@hansjovis hansjovis commented Dec 7, 2022

Context

  • We need to be able to override the shortlinks within the Inclusive language analysis from within Shopify SEO so we can determine from which platform the traffic to the website is coming from. This PR adds a method to do that.

Summary

This PR can be summarized in the following changelog entry:

  • [yoastseo] Adds the possibility to change the links to the "learn more" URLs in the Inclusive language assessments.

Relevant technical choices:

  • Do NOT merge trunk into this branch. This branch has been created based on the release branch, will be used in Shopify, and should not contain any unstable changes.
  • Do NOT remove this branch after merging. This branch will be used in Shopify.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Relevant test scenarios

  • Changes should be tested with the browser console open
    • Not specifically needed, but good to do anyway in case of errors in the JavaScript code.
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Block/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:

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.

Quality assurance

  • I have tested this code to the best of my abilities
  • 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.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes https://yoast.atlassian.net/browse/PC-976

@hansjovis hansjovis added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Dec 7, 2022
@hansjovis hansjovis added this to the 19.12 milestone Dec 7, 2022
@hansjovis hansjovis changed the base branch from release/19.12 to trunk December 8, 2022 12:31
@hansjovis hansjovis marked this pull request as ready for review December 8, 2022 12:34
setInclusiveLanguageOptions( options ) {
this._inclusiveLanguageOptions = options;
}

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.

@hansjovis When we added additional methods in the worker like setCustomSEOAssessorClass, we also bind it inside the constructor. But we don't do it to setInclusiveLanguageOptions here. Do you know if "binding" or not "binding" it to the scope will have no difference for setInclusiveLanguageOptions?

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.

Yes, binding it inside of the constructor would be the best option. To avoid any edge cases when calling the method.

Could you implement that? 🙂 I don't have time at the moment.

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.

I'll do that! :)

Copy link
Copy Markdown
Contributor

@FAMarfuaty FAMarfuaty left a comment

Choose a reason for hiding this comment

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

CR and Acceptance test 💯

@FAMarfuaty FAMarfuaty modified the milestones: 19.12, 19.13 Dec 9, 2022
@FAMarfuaty FAMarfuaty merged commit 89a5291 into trunk Dec 9, 2022
@FAMarfuaty FAMarfuaty deleted the PC-976-adapt-inclusive-language-shortlinks-for-shopify branch December 9, 2022 15:00
@FAMarfuaty FAMarfuaty restored the PC-976-adapt-inclusive-language-shortlinks-for-shopify branch December 9, 2022 15:01
@enricobattocchi enricobattocchi modified the milestones: 19.13, 19.14 Dec 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants