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

As a content manager, I want to know what the page audit panel is for and how to enable Page Audits

    Details

      Description

      Motivation

      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.

      As an API key for the Page Speed service is needed, we must include some information in the panel to facilitate on-boarding.

      We also need to add a new icon in the Control bar to display the panel.

      Design

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

      svg illustration:
      issues-default.svg

      Technical Requirements

      • When the Enable Page Audit check is on (see LPS-125851), the icon for displaying the Page Audit panel will be listed in the control bar in the view mode of a content/widget/display page.
      • Permissions for seeing the icon will be the same set for the content performance panel.
      • While the API key is not configured, a message and an image will be shown: Check issues that impact on your page's accessibility and SEO. Connect with Page Speed from Instance or Site Settings > Pages > PageSpeed. 
        • Nice to have feature: If the user has permissions to access the API's config (see LPS-125851), a Connect with Page Speed button will show. This button will led to config in system / instance / site settings. When clicking Save, Cancel or Back buttons, the user will be led the page view again.
      • Panel will be closed with a times-icon

      Acceptance Criteria

      • Given a content / widget / display page
      • When the Enable Page Audit check in site settings is off 
      • Then the issue icon for displaying the page audit panel doesn't show

      • Given a content / widget / display page
      • When the user with permissions to view page visits the view mode
      • Then the issue icon for displaying the page audit panel shows

      • Given the Page Audit Panel
      • When PageSpeed's API Key is not configured and the user has no permissions for accessing to the site settings
      • Then a message and an image show: Check issues that impact on your page's accessibility and SEO. Connect with Page Speed from Instance or Site settings > Pages > PageSpeed.

      (NtH)

      • Given the Page Audit Panel
      • When PageSpeed's API Key is not configured and the user has permissions for accessing to the site settings
      • Then a message, an image and a button show: Check issues that impact on your page's accessibility and SEO. Connect with Page Speed.  

       --
      (NtH)

      • Given the Page Audit Panel
      • When PageSpeed's API Key is not configured and the user has permissions for accessing to the site settings
      • Then the button Connect with Page Speed leads to the Site Settings > Pages > PageSpeed.

      (NtH)

      • Given the Connect with Page Speed button
      • When the user is led to the config page, and s/he clicks Save, Cancel or Back buttons
      • Then the user is led to the page view again.

       Test Scenarios

      AC ID Test Strategy Test Scenarios Is it covered by FrontEnd ? (JS-Unit) Is it covered by BackEnd? (unit or integration) Poshi?
      01 Low When the Enable Page Audit check in site settings is off, the issue icon to display the page audit panel in the content pages doesn't show      
      02 Low When the Enable Page Audit check in site settings is off, the issue icon to display the page audit panel in the widget pages doesn't show      
      03 Low When the Enable Page Audit check in site settings is off, the issue icon to display the page audit panel in the display page templates doesn't show      
      03 Critical When the PageSpeed's API Key is configured and a user with permissions to view page visits the view mode of a content page, the issue icon for displaying the page audit panel shows      
      04 Critical When the PageSpeed's API Key is configured and a user with permissions to view page visits the view mode of a widget page, the issue icon for displaying the page audit panel shows      
      05 Critical When the PageSpeed's API Key is configured and a user with permissions to view page visits the view mode of a display page template, the issue icon for displaying the page audit panel shows      
      06 Medium When the PageSpeed's API Key is not configured and a user, with no permissions to access to Site settings, accesses to the Page Audit panel, a message and an image show: Check issues that impact on your page's accessibility and SEO. Connect with Page Speed from Instance or Site settings > Pages > PageSpeed.      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              sarai.diaz Sarai Diaz
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Sarai Diaz
              Recent user:
              Cristina Gonzalez
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Packages

                  Version Package