This document will go over how to install and use the SiteImprove Drupal module

Installation steps

1. Check out and update the site's code repository.  The repository information can be found from the ‘Connection Info’ button on the Pantheon dashboard. 
   
   More information about working with Composer and a site’s code can be found in our Build a site with Composer KB article.
   
   
2. From the module project page, scroll to the bottom of the page and look for the the version that supports your current Drupal version, ex:
   
   composer require drupal/siteimprove:^3
   
   From your terminal and within the site code repository, run the “composer require” command.
   
   This will install the code for the module locally, then add, commit and push the changes made to the site code repository.  Help with repository commands can be found in the “Build a site with Composer” article above.
3. Once the code change has been pushed to your site, it will be available on your development environment.  From the ‘Test’ tab in Pantheon promote the code up to your test environment,  and then do the same for your live environment so you can utilize the module on your live site.
4. From the ‘Extend’ menu within your live environment site, search for ‘SiteImprove’.
   
   Check the checkbox next to ‘SiteImprove plugin’, and click the ‘Install’ button at the bottom of the page.

Usage/Interpreting Your Results

Siteimprove’s plugins must be connected to a Siteimprove account. In order to utilize the plugin, log in to Siteimprove (see our Create a Siteimprove Account KB article) and request access to your sites by emailing itaccessibility@umd.edu. 

The Siteimprove Drupal plugin gives real-time reports of pages as they are worked on, which supplement the bi-weekly crawls from the platform itself. This allows you to review accessibility barriers that are not in compliance with the Web Content Accessibility Guidelines as you build your content. 

Each site is given a score on accessibility that is based on the types of errors found in your content. While digital accessibility is a dynamic subject that can’t be determined by one score alone, the Siteimprove scoring system is a helpful reference towards how Siteimprove weighs various WCAG criteria. It does not, however, encompass all the complexities of accessibility. Use your score as a point of reference in the progression of your digital accessibility journey.

Reports also give a list of accessibility issues along with your general score. Selecting detected issues brings you to a Siteimprove report on your current page, which highlights each occurrence of the issue on the page. The report also gives a brief explanation and possible solutions.

For a more detailed evaluation of your full site beyond the plugin’s capabilities, use the Siteimprove platform. More information on the evaluation and report features for Siteimprove can be found in our Web Accessibility Compliance with Siteimprove article. Please contact Siteimprove Support or itaccessibility@umd.edu  with any questions.

Troubleshooting

If you are having trouble with the module not showing the SiteImprove window or reporting an error, try the following:

Disable add blockers

Try disabling addons like Ublock Origin for the site you are on

Disable “Enhanced Tracking Protection

If you are using the Firefox browser, you may need to disable some of Firefox’s extra protections.  To disable “Enhanced Tracking Protection”, click on the shield icon on your browser address bar, and turn off the setting, like in the picture below.