Skip to content

Alt text for Images, Banners and Slides for better accessibility and SEO #787

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

Merged
merged 11 commits into from
Dec 8, 2021

Conversation

manavluhar
Copy link
Contributor

@manavluhar manavluhar commented Oct 11, 2021

Description (*)

  • SEO Fieldset in Page Builder Image / Banner / Slide
    seo-fieldset-in-page-builder-form

  • Banner SEO in frontend
    banner-seo-proof

  • Slider SEO in Frontend
    slide-seo-proof

  • Image is already having SEO functionality

Story

  • 746 Alt text for Images

Fixed Issues (if relevant)

  1. Alt text for Images #746: Alt text for Images

Manual testing scenarios (*)

  • By going inside Admin Panel -> CONTENT -> Pages -> Edit Home page open Content section and click on Edit with Page Builder button.
  • Add New Banner/Add New Slider -> Hover on the Banner Area / Edit Slide -> Click On ⚙️[Edit] Here admin can find Search Engin Optimization Fieldset.
  • Inside Search Engin Optimization Fieldset Alternative Text and Title Attribute fields will be there.
  • After filling required fields, One can check by going to the Storefront -> Home page and inspect Banner / Slide / Image and check that Alternative Text and Title Attribute will be there which makes PageBuilder content accessible and SEO optimized

Questions or comments

Checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@manavluhar
Copy link
Contributor Author

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@manavluhar
Copy link
Contributor Author

@magento run Functional Tests B2B, Functional Tests CE, Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@manavluhar
Copy link
Contributor Author

@magento run Functional Tests B2B

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@manavluhar
Copy link
Contributor Author

@magento run Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Oct 12, 2021

@magento run Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Copy link
Contributor

@sidolov sidolov left a comment

Choose a reason for hiding this comment

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

@manavluhar changes look good to me. Could you please cover new functionality with MFTF test? (maybe a good idea to find already created tests and edit them to fill new fields and then check them on the storefront)

@manavluhar
Copy link
Contributor Author

Sure @sidolov will do that! 🙌

@sidolov sidolov added the Priority: P1 Priority: P1 label Oct 15, 2021
@manavluhar
Copy link
Contributor Author

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@manavluhar
Copy link
Contributor Author

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE, Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sdzhepa sdzhepa linked an issue Oct 20, 2021 that may be closed by this pull request
@sdzhepa
Copy link

sdzhepa commented Oct 20, 2021

UPDATE on 11 Nov 2021

This PR requires additional discussion with PO

Admin Side

New Section "Search Engine Optimization" was added to the Banner and Slider PageBuilder content types.
The section contains new fields/settings: "Alternative Text" and " Title Attribute"

  • Was tested that these options exist and Admin users can edit them.
  • Was tested these attributes are available(shown) on the Storefront

Banner

Banner

Slider(available per each slide)

Slider

Storefront Side

Banner

SF_Banner

Slider(available per each slide)

SF_Slider

@sidolov
Copy link
Contributor

sidolov commented Oct 26, 2021

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Nov 12, 2021

@magento run all tests

@sidolov
Copy link
Contributor

sidolov commented Nov 24, 2021

@magento run Functional Tests B2B,Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sdzhepa
Copy link

sdzhepa commented Nov 24, 2021

QA Passed after reworking of PR

Were tested next Page Builder entities: Banner, Image, Slider
Were tested when this entity inside Row and Tab "containers"

  • image tag has added alt attribute
  • for div was used aria-label instead.

Additional was performed testing using Screen Reader: All alternative text for all these entities can be read by screen reader

Note: Looks like implementation is done, only some failed functional tests. Fails look like related to the incorrect locators. So i assume no code changes just fix test. But in case if any code changes will be performed to change implementation/logic pls ping me for one more testing round

@sidolov
Copy link
Contributor

sidolov commented Nov 29, 2021

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Nov 29, 2021

@magento run Functional Tests B2B,Functional Tests CE,Functional Tests EE,WebAPI Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Nov 30, 2021

@magento run Functional Tests B2B,Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Nov 30, 2021

@magento run Functional Tests B2B,Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Nov 30, 2021

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Dec 1, 2021

@magento run Functional Tests B2B,Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Dec 1, 2021

@magento run Functional Tests B2B,Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Dec 1, 2021

@magento run Functional Tests B2B,Functional Tests CE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Dec 1, 2021

@magento run Functional Tests B2B,Functional Tests CE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

2 similar comments
@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@sidolov
Copy link
Contributor

sidolov commented Dec 2, 2021

@magento import pr to magento-commerce/magento2-page-builder

@m2-github-services
Copy link

@sidolov the Pull Request is successfully imported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Alt text for Images
5 participants