Skip to content

Add documentation on ecommerce assessments#22197

Merged
hannaw93 merged 13 commits intotrunkfrom
add-documentation-on-ecommerce-assessments
May 1, 2025
Merged

Add documentation on ecommerce assessments#22197
hannaw93 merged 13 commits intotrunkfrom
add-documentation-on-ecommerce-assessments

Conversation

@agnieszkaszuba
Copy link
Copy Markdown
Contributor

@agnieszkaszuba agnieszkaszuba commented Apr 15, 2025

Context

  • The assessment scoring documentation in the yoastseo package was missing information on e-commerce assessments. Since the code for most of these assessments is inside the yoastseo package (with the exception of the product short description assessment for Woo), it makes sense to also have documentation for it.

Summary

This PR can be summarized in the following changelog entry:

  • Removes unnecessary config for the outbound links assessment from the cornerstone SEO assessor, which is the same as the default config.
  • [shopify-seo] Removes unnecessary config for the outbound links assessment from the cornerstone SEO assessor, which is the same as the default config.
  • [yoastseo other] Updates assessment scoring documentation to include e-commerce assessments.
  • [yoastseo enhancement] Removes unnecessary config for the outbound links assessment from the cornerstone SEO assessor, which is the same as the default config.

Relevant technical choices:

  • I found that in the cornerstone assessor, we pass custom config for the outbound links assessment, which is the same as the default config. I removed it. (It is probably a relic from when we gave a better score for non-cornerstone content without outbound links, see for example this commit).
  • I fixed some mistakes in the ASSESSORS OVERVIEW.md file, but I didn't add documentation on the e-commerce assessors to it. I created a separate issue for that: https://github.com/Yoast/reserved-tasks/issues/985

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:
N

  • Create a post without any content
  • Confirm that the outbound links assessment returns a red traffic light with the following feedback: Outbound links: No outbound links appear in this page. Add some!
  • Switch on the cornerstone content toggle
  • Confirm that the feedback remains the same.

Note: this change is not user-facing, so the feedback before the PR is the same. The goal is to check if the assessment feedback is still correct after changing the configuration.

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 other 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.

I have updated the Confluence documentation on e-commerce analysis to link to the documentation in the yoastseo package.

Note for reviewer: After merging the PR, please update the following links in the Confluence documentation on e-commerce analysis to link to trunk instead of the issue branch:

  • SEO analysis in products (Shopify & Woo)
  • Readability analysis in products (Shopify & Woo)
  • SEO analysis in collections (Shopify)

And also the Image alt tags link at the bottom of this page: Product SEO scoring Japanese (Woo & Shopify)

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 Add documentation for e-commerce assessments to the yoastseo package

@agnieszkaszuba agnieszkaszuba requested a review from Copilot April 15, 2025 12:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

@agnieszkaszuba agnieszkaszuba added the changelog: other Needs to be included in the 'Other' category in the changelog label Apr 15, 2025
@agnieszkaszuba agnieszkaszuba added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog changelog: other Needs to be included in the 'Other' category in the changelog and removed changelog: other Needs to be included in the 'Other' category in the changelog changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Apr 17, 2025
@FAMarfuaty
Copy link
Copy Markdown
Contributor

The feedback strings for "Image alt tags" assessment are changed in this PR: #22220

@github-actions
Copy link
Copy Markdown

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

@hannaw93
Copy link
Copy Markdown
Contributor

hannaw93 commented May 1, 2025

CR + testing👍🏼🙌🏼 Resolved a merge conflict and added a note in the test instructions (to make it clear why we are testing the assessment feedback if the change is non-userfacing). Great job especially on doing additionnal improvements for the documentation :)

@hannaw93 hannaw93 modified the milestones: 25.1, 25.2 May 1, 2025
@hannaw93 hannaw93 merged commit 8ba08ff into trunk May 1, 2025
24 checks passed
@hannaw93 hannaw93 deleted the add-documentation-on-ecommerce-assessments branch May 1, 2025 13:35
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 Shopify This PR impacts Shopify.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants