Adjust applicability of the assessments Single title and Competing links

[marinakoleva]

Context

• Part of the "off the bat" project where we make all assessments available as soon as the analysis menu is opened.
• This PR:
  • adds a new good 🍏 condition for Single title and Competing links;
  • changes the name of the Link keyphrase assessment to Competing links;
  • improves the feedback string for the bad 🍎 condition of Competing links by making it clearer.
• About the Single title assessment, here is some more context on why we flag 2 or more H1s in the body of the text, rather than 1 or more: slack thread.

Summary

This PR can be summarized in the following changelog entry:

• Makes the assessments single title and competing links available from the get-go in the SEO analysis.
• [shopify-seo] Makes the assessments single title and competing links available from the get-go in the SEO analysis.
• [yoast-doc-extension] Makes the assessments single title and competing links available from the get-go in the SEO analysis.
• Renames the link keyphrase assessment to competing links.
• [shopify-seo] Renames the link keyphrase assessment to competing links.
• [yoast-doc-extension] Renames the link keyphrase assessment to competing links.
• Improves the feedback of the competing links assessment by making it clearer.
• [shopify-seo] Improves the feedback of the competing links assessment by making it clearer.
• [yoast-doc-extension] Improves the feedback of the competing links assessment by making it clearer.
• [yoastseo] Changes the applicability criteria of the assessments single title and competing links so that they are available immediately in the analysis.

Relevant technical choices:

• The feedback strings were determined in this document: Single title and Competing links: Off the bat. You can find the reasoning behind the final strings and scores there.
• For ease, here is a list of the assessors for which the assessments are available and for which they are not:
  • TextCompetingLinks
    • YES: posts, product pages, store posts and pages (and related RelatedKeywordAssessor)
    • NO: taxonomies, collection pages, store blogs (and their RelatedKeywordAssessor)
  • SingleH1
    • YES: posts, taxonomies, product pages, Collection pages, store posts and pages (but NOT in their RelatedKeywordAssessor)
    • NO: store blogs

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Can be used to test a post in WP, a product in Shopify, or a Google doc

1. Have Yoast SEO Free active

• Create a new post / product / doc and open the SEO analysis menu
  • Confirm both assessments Single title and Competing links are present in the Good results section with a 🍏 green traffic light, and the following feedback strings:
  • Single title: You don't have multiple H1 headings, well done!
  • Competing links: There are no links which use your keyphrase or synonym as their anchor text. Nice!
• Add a focus keyphrase
  • Confirm you can still see the same feedback as above
• Remove the focus keyphrase and add some text with a few paragraphs
  • Confirm you can still see the same feedback as above
• Add again the focus keyphrase
  • Confirm you can still see the same feedback as above
• Add one H1 heading to the body of the post
  • Confirm the Single title assessment still returns a 🍏 green traffic light saying, You don't have multiple H1 headings, well done!
• Add one more H1 heading to the body of the post
  • Confirm the Single title assessment now returns a 🍎 red traffic light with the following string: Single title: H1s should only be used as your main title. Find all H1s in your text that aren't your main title and change them to a lower heading level!
• Add the keyphrase to the body of the post, and attach a link to it (e.g. focus keyphrase: dingo, in the post: dingo)
  • Confirm the Competing links assessment now returns a 🍎 red traffic light with the following string: Competing links: You have a link which uses your keyphrase or synonym as its anchor text. Fix that!
• Remove the keyphrase and link from the body.
• Save the post

2. Build/ activate Premium
   ⚠️ For Google doc, no need to execute this scenario. Related keyphrase analysis is not available in Google docs extension

• Open the same post
• Open the Related keyphrase menu and add a related keyphrase
  • Confirm the Competing links assessment is present in the Related keyphrase menu and it returns a 🍏 green traffic light with the string "Competing links: There are no links which use your keyphrase or synonym as their anchor text. Nice!"
• Add the Related keyphrase to the body of the post, and attach a link to it (e.g. Related keyphrase: tasmanian devil, in the post: tasmanian devil)
  • Confirm the Competing links assessment now returns a 🍎 red traffic light with the following string: Competing links: You have a link which uses your keyphrase or synonym as its anchor text. Fix that!

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:

• N/a

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 #549

[coveralls]

Pull Request Test Coverage Report for Build a940fe8b79e2138018fc939e9122b76dc1ed3937

Details

• 8 of 8 (100.0%) changed or added relevant lines in 2 files are covered.
• No unchanged relevant lines lost coverage.
• Overall first build on 549-adjust-applicability-of-the-assessments-single-title-and-competing-links at 58.684%

---

Totals
Change from base Build 8eb057b381812c0c10cda66e3bc4603539f1d577:	58.7%
Covered Lines:	14069
Relevant Lines:	23663

---

💛 - Coveralls

[Jordi-PV]

AT: WP post ✅ Woo product ✅ Shopify product ✅

CR: 👌

Works like a charm! 👏

[marinakoleva]

@Jordi-PV Thanks for testing it in Shopify as well! 🙏 😄