Introduction

Acquia Web Governance is available as a powerful and intuitive Drupal module specifically engineered to empower content editors and site administrators. Its core functionality revolves around enhancing critical aspects of a website, including: 

• Search Engine Optimization
  (SEO)

Introduction

Acquia Web Governance is available as a powerful and intuitive Drupal module specifically engineered to empower content editors and site administrators. Its core functionality revolves around enhancing critical aspects of a website, including: 

• Search Engine Optimization
  (SEO)

• Accessibility

• Data Privacy

• Readability

Web Governance provides real-time feedback and actionable insights, and enables users to proactively identify and address potential issues as content is created or updated, rather than after publication. This proactive approach saves valuable time and ensures that the website consistently adheres to best practices and regulatory standards.

This document provides instructions on how to do the initial setup, explains key features and functionalities, and provides practical tips on how to use the module effectively to ensure that your website remains optimized, inclusive, and engaging for all visitors.

What you will achieve

• Improved SEO: Identify and get instructions on how to improve search engine optimization deficiencies.
• Enhanced Accessibility: Ensure adherence to WCAG 2.0/2.1/2.2 compliance standards.
• Better Readability: Assess and improve content complexity levels.
• Real-time Analysis: Obtain immediate feedback during content creation.
• Canvas Integration: Perform a seamless content scan within the Canvas authoring environment.

Prerequisites and requirements

System requirements

• Drupal Core: Version 10.3+ or 11.x
• PHP: Version 8.1 or higher
• Composer: 2+
• Node: 18+
• NPM: 10+

Account requirements

• Web Governance account: An active registered Web Governance account.
• API credentials: An API Key and API URL retrieved from your Web Governance dashboard. This requires Administrative access in Web Governance. For instructions, visit API tokens.
• Appropriate permissions: Administrative access in Drupal is required to configure the module.

Installation guide

1. Install the Drupal module with the Composer (recommended) plugin.

   composer require drupal/acquia_optimize

2. Enable the Drupal module with one of the following methods

• Enable with Drush

  drush en acquia_optimize -y

• Enable with the Drupal Admin UI

  • Navigate to admin > modules and enable the Acquia Web Governance module.

Initial configuration

Access the Configuration Page in Drupal

• Navigate to: /admin/config/content/acquia-optimize

API Configuration

1. Log in to your Web Governance account.
2. Retrieve the API token. For instructions on how to retrieve the API token, visit API tokens.
3. Generate or copy your:
   • API Key: A unique identifier for your account.
   • API URL: The designated endpoint for API communication.

Configuring API settings in Drupal

• API Key: Enter your Web Governance API token.
• API URL: Enter the API endpoint URL.
• Connection validation:
  • The system automatically validates the provided credentials.
  • Pre-validation checks are performed before the system makes a successful connection.
• Debug Mode: Enable this so that the user can see the logs in the console when they perform a quick scan with the Acquia Web Governance extension.

Setting accessibility guidelines

Select your desired accessibility compliance level in Drupal:

Recommendation: WCAG2-AA is recommended for general websites.

User management and permissions needed in Drupal

There are two available permissions for this module in Drupal:

• Scan Acquia Web Governance
• Administer Acquia Web Governance 

Scan Acquia Web Governance 

• Who needs it:
  • Content editors
    • Authors
    • Reviewers
• What it allows:
  • Users with this permission can do quick scans on content.
  • Users with this permission can view scan results.
  • Users with this permission can access the scan interface.

Administer Acquia Web Governance 

• Who needs it: Site administrators and technical leads.
• What it allows:
  • Users with this permission can access to configuration settings.
  • Users with this permission can modify API credentials.
  • Users with this permission can change accessibility guidelines.
  • Users with this permission can enable or disable debug mode.
  • Users with this permission gain access to all scanning permissions.

Additional resources

The following resources are available for this application:

• Quick Scan in Drupal setup
• How to do the Quick Scan in Drupal
• Developers page about Drupal
• Acquia Web Governance page on Drupal.org