Siteimprove.ai
Integrates Drupal with the Siteimprove.ai Intelligence Platform to provide content quality and analytics insights during content creation and editing.
siteimprove
Install
composer require 'drupal/siteimprove:^3.0'
composer require 'drupal/siteimprove:^2.0'
Overview
The Siteimprove.ai Plugin bridges the gap between Drupal and the Siteimprove.ai Intelligence Platform. It enables content editors to access Siteimprove.ai analytics and content insights directly within their content creation and editing workflow. With the overlay feature, contributors can test, fix, and optimize their work continuously without leaving the Drupal interface.
The module provides a prepublish check feature that allows content to be analyzed before publication, ensuring quality standards are met. Once issues are detected and addressed, users can directly re-check pages to verify fixes. The module supports nodes, taxonomy terms, and Group module entities.
A flexible frontend domain plugin system allows sites with different backend and frontend domains to correctly report URLs to Siteimprove.ai. Built-in plugins support default domains, single custom domains, and Domain Access module integration.
Features
- Real-time Siteimprove.ai overlay integration for viewing analytics and content insights while editing
- Prepublish content check to analyze content before publication
- Recheck functionality to verify fixes immediately after addressing detected issues
- Toolbar integration providing quick access to Siteimprove.ai actions
- Flexible frontend domain plugin system for sites with separate backend/frontend domains
- Support for nodes, taxonomy terms, and Group module entities
- Configurable overlay appearance including collapse by default option
- Automatic notification to Siteimprove.ai when content is saved
- Integration with content moderation workflows supporting latest revision checks
Use Cases
Content quality assurance during editing
Content editors can view Siteimprove.ai insights while editing pages. The overlay displays accessibility issues, SEO recommendations, and quality metrics in real-time, allowing immediate corrections.
Pre-publication content validation
Before publishing new content, editors can run a prepublish check to analyze the content for issues. This ensures content meets quality standards before going live, reducing post-publication fixes.
Multi-domain site management
For sites with separate backend and frontend domains, use the Single frontend domain plugin or Domain Access integration to ensure Siteimprove.ai receives the correct public URLs.
Content recheck after updates
After saving content, the module automatically triggers a recheck with Siteimprove.ai. Editors can also manually recheck pages to verify their fixes resolved detected issues.
Editorial workflow integration
Combined with Content Moderation, editors can check content quality on draft revisions before requesting review, integrating quality assurance into the editorial workflow.
Tips
- Ensure all content editors who need Siteimprove.ai access have the 'Access Siteimprove.ai Plugin' permission
- Use the 'Collapse overlay by default' option if the expanded overlay is distracting during content editing
- For HTTPS-only sites, enable the 'secure' cookie attribute option for better security
- The prepublish check works best when enabled only for the content types that require quality validation
- Create a custom SiteimproveDomain plugin if your site has complex frontend domain requirements not covered by built-in plugins
Technical Details
Admin Pages 1
/admin/config/system/siteimprove
Configure the Siteimprove.ai integration including authentication token, frontend domain settings, prepublish check options, and overlay behavior.
Permissions 3
Hooks 1
hook_siteimprove_siteimprove_domain_info_alter
Alter the Siteimprove.ai Domain plugin definitions. Allows modules to modify plugin metadata or add additional plugins.
Troubleshooting 5
Verify the user has the 'Access Siteimprove.ai Plugin' permission. Check that ad blockers are disabled as they may block the overlay iframe. Ensure the token is properly configured.
After enabling prepublish check with valid API credentials, Siteimprove.ai may take several minutes to enable the feature on their end. Wait and check back later.
Verify your API username and API key are correct. Ensure your Siteimprove.ai subscription includes the Prepublish feature.
Configure the appropriate Frontend Domain plugin. Use 'Single frontend domain' for sites with different backend/frontend domains, or install siteimprove_domain_access for Domain Access sites.
Click the 'Request new token' button to generate a new authentication token from Siteimprove.ai.
Security Notes 3
- The API username and API key for prepublish check are stored in configuration. Ensure proper configuration management practices.
- The module communicates with external Siteimprove.ai servers. Ensure your content security policies allow connections to cdn.siteimprove.net and my2.siteimprove.com.
- Grant the 'Administer Siteimprove.ai Plugin' permission only to trusted administrators as it provides access to API credentials.