Add documentation on ecommerce assessments#22197
Merged
Conversation
2 tasks
Contributor
|
The feedback strings for "Image alt tags" assessment are changed in this PR: #22220 |
|
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. |
Contributor
|
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 :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
yoastseopackage was missing information on e-commerce assessments. Since the code for most of these assessments is inside theyoastseopackage (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:
Relevant technical choices:
ASSESSORS OVERVIEW.mdfile, 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/985Test instructions
Test instructions for the acceptance test before the PR gets merged
This PR can be acceptance tested by following these steps:
N
Outbound links: No outbound links appear in this page. Add some!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
Test instructions for QA when the code is in the RC
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
Other environments
[shopify-seo], added test instructions for Shopify and attached theShopifylabel to this PR.Documentation
I have updated the Confluence documentation on e-commerce analysis to link to the documentation in the
yoastseopackage.Note for reviewer: After merging the PR, please update the following links in the Confluence documentation on e-commerce analysis to link to
trunkinstead of the issue branch:And also the Image alt tags link at the bottom of this page: Product SEO scoring Japanese (Woo & Shopify)
Quality assurance
Innovation
innovationlabel.Fixes Add documentation for e-commerce assessments to the yoastseo package