Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-119066

As a content manager, I want to know how many SEO and accessibility related issues my page has

    Details

    • Sprint:
      TANGO | #43 DIS | Aug14-Aug28, TANGO | #44 DIS | Aug28-Sep11, TANGO | #51 DIS | Dec11-Dec28, TANGO | #52 DIS | Jan12-Jan22, TANGO | #53 DIS | Jan22-Feb05, TANGO | #54 DIS | Feb05-Feb19, TANGO | #55 DEV | Feb19-Mar05, TANGO | #56 DEV | Mar05-Mar19, TANGO | #57 DEV | Mar22-Apr05, TANGO | #58 DEV | Apr05-Apr16, TANGO | #59 DEV | Apr16-Apr30, TANGO | #60 DEV | Apr30-May14, TANGO | #61 DEV | May14-Jun04

      Description

      Motivation

      Content authors are concerned about their content to have the adequate visibility in search engines, so they can reach the right audiences. To ensure that a page is optimized for search engine indexing and visibility, it is necessary to check the page's compliance with best practices in terms of performance, accessibility, search engine metadata and SEO. Page audit test allows to make a quick check of that compliance and get warnings and tips to improve each one of the categories.

      Once the API Key is enabled, the Page Audit panel will show the detail of the issues in two sections: Accessibility and SEO Best Practices, and will provide access to the detail section.

      Design

      https://www.figma.com/file/I0BImwTEY740kKEseduLU5/LPS-111803-Page-audit---check-one-page-issues?node-id=0%3A1
      Success gif:

      Requirements

      1. A progress bar will show while retrieving the data.

      2. There will be a field to show page's title and another one for the URL being audited (as in the content performance panel)

      3. There will be a switch for changing language / URL requested

      4. There will be two collapsible sections: Accessibility and SEO.

      4.1. Sections will be closed by default

      4.2. Sections will show the total count of issues to fix for that category (Only "fails" will be shown in the total count)

      4.3. Sections will display when clicking on the arrow

      5. When displaying sections, a list of checks and number of issues for each one will be shown.

      5.1. Only those checks with failing elements retrieved will appear on the list.

      5.2. Clicking in the matching line will lead to the detail level. (Titles for checks are specified in LPS-127668 and LPS-127672)

      6. As we are retrieving failing elements up to 100 (see LPS-127668 and LPS-127672), when there are more than 100 (in a particular issue or in the addition of all of them) the number will show +100

      7. If there aren't any issues to fix, a message "Congratulations! Your page doesn’t have any Accessibility or SEO issues to fix." and an image will be shown.

      7.1. The sections SEO and Accessibility will show collapsed

      7.2. No number / Number 0 of issues icon will show

      7.3. A message "There are no SEO / Accessibility related issues" will show

      Note: Error handling will be tackled in LPS-128081

      Requirements
       
      Acceptance Criteria
       
      Test Strategy
       
      Covered by frontend / backend test? (Yes/No)
       
      1. A progress bar will show while retrieving the data.  
      • Given the Page Audit Panel 
      • When the audit is launched (the API is called)
      • Then a progress bar shows and moves forward while retrieving the data until they can be shown.
      Medium  No
      2. There will be a field to show page's title and another one for the URL being audited (as in the content performance panel)
      • Given the Page Audit Panel 
      • Then the name of the page shows
      Medium  Yes
       
      • Given the Page Audit Panel 
      • Then the URL of the page shows
      Medium  Yes
      3. There will be a switch for changing language / URL requested
      • Given the Page Audit Panel 
      • Then the language selector shows
      Lowest  Yes
       
      • Given the Page Audit Panel 
      • When the user clicks on the language selector and selects other language
      • Then the title of the page shows the matching translation (if existing), the URL changes (if localized URLs is enabled) and the API is called so the progress bar shows
      Medium No
      4. There will be two collapsible sections: Accessibility and SEO. 
      4.1. Sections will be closed by default
      • Given the Page Audit Panel
      • Then the section SEO is collapsed by default
      Medium  
       
      • Given the Page Audit Panel 
      • Then the section Accessibility is collapsed by default
      Medium  
      4.2. Sections will display when clicking on the arrow
      • Given the Page Audit Panel
      • Then the section SEO is displayed when clicking on the arrow icon
      High  
       
      • Given the Page Audit Panel
      • Then the section Accessibility is displayed when clicking on the arrow icon
      High  
      4.3. Sections will show the total count of issues to fix for that category (Only "fails" will be shown in the total count)
      • Given the Page Audit Panel
      • When the user opens SEO section and issues are retrieved
      • Then only those checks with failing elements retrieved are taken into account for the count
      Low  
       
      • Given the Page Audit Panel
      • When the user opens Accessibility section and issues are retrieved
      • Then only those checks with failing elements retrieved are taken into account for the count
      Low  
      5. When displaying sections, a list of checks and number of issues for each one will be shown.
      5.1. Only those checks with failing elements retrieved will appear on the list.
      • Given the Page Audit Panel 
      • When the issues are retrieved and the user clicks on the arrow icon of the SEO section
      • Then a list of checks and number of failing elements for each one of them will be shown.
      High  
       -- 
      • Given the Page Audit Panel 
      • When the issues are retrieved and the user clicks on the arrow icon of the Accessibility section
      • Then a list of checks and number of failing elements for each one of them will be shown.
      High  
       5. When displaying sections, a list of checks and number of issues for each one will be shown.
      5.2. Clicking in the matching line will lead to the detail level. 
      •  Given the SEO section
      • When the user clicks on one of the issues
      • Then s/he navigates to the detail level of the issue (failing elements)
      Critical  
       -- 
      •  Given the Accessibility section
      • When the user clicks on one of the issues
      • Then s/he navigates to the detail level of the issue (failing elements)
      Critical  
       6. As we are retrieving failing elements up to 100 (see LPS-127668 and LPS-127672), when there are more than 100 (in a particular issue or in the addition of all of them) the number will show +100  
      • Given the Page Audit Panel 
      • When the failing elements retrieved for any of the checks or the addition of all failing elements in a section are more than 100
      • Then the number of failing elements shows as +100 in the title and in the particular check
      Medium  Yes
      7. If there aren't any issues to fix, a message "Congratulations! Your page doesn’t have any issues to fix." and an image will be shown.
      7.1. The sections SEO and Accessibility will show collapsed
      • Given the Page Audit Panel
      • When the user opens it and there are no failing elements retrieved for any of the checks
      • Then a message (Congratulations! ...) and the matching image show, the two sections SEO and Accessibility show and they are collapsed by default
      Medium  
      7.2. No number / Number 0 of issues icon will show
      7.3. A message "There are no SEO / Accessibility related issues" will show
      • Given the Page Audit Panel 
      • When the user opens it and there are no failing elements retrieved for any of the checks
      • Then a number 0 of issues icon will show in each of the sections, and if the user clicks on the arrow icon the section displays and a message is shown: "There are no [SEO / Accessibility] related issues"
      Medium  

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              support-qa Support QA
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Sarai Diaz (Inactive)
              Recent user:
              Luiz Queiroz
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Packages

                  Version Package
                  7.4.1 CE GA2 DXP 7,4
                  Master