Skip to main content

This package is a Plone add-on that provides integration with siteimprove.com, a service for maintaining and improving website content. Siteimprove provides customers with automated scans of their websites which check for content quality, accessibility compliance, SEO, and performance. The add-on gives content editors immediate feedback on the quality of pages that they publish, with a summary report provided in a page overlay and links to more details. This lets Siteimprove customers see problems while they are in the process of editing a page on their Plone site, instead of getting emailed a report after the fact and needing to click through links to fix things.

collective.siteimprove provides the integration with Siteimprove’s CMS plugin API that is required to provide these features. The only thing Plone admins need to do is install the add-on and configure a Siteimprove token.

For more information on using Siteimprove within Plone, see How to navigate the Siteimprove CMS Plugin.

Features

  • Control panel for requesting and saving a siteimprove.com token

  • Siteimprove overlay button shows for authorized users on all default views

  • Overlay button provides link to login/logoout to Siteimprove account

  • Overlay button can show summary info for the domain or info for the page you are on, for publicly visible content

  • Overlay button provides link to manually trigger page recheck action

  • Overlay button provides link to re-crawl site

  • Publishing or saving a published page triggers recheck action

Customization

This add-on creates a new permission “collective.siteimprove: Use Siteimprove” (zcml id “collective.siteimprove.UseSiteimprove”) for viewing Siteimprove screens and requesting content scans. This permission is assigned to the “Editor”, “Reviewer”, “Site Administrator”, and “Manager” roles by default. Those assignments can be changed via the ZMI or custom code.

Installation

Install collective.siteimprove by adding it to your buildout:

[buildout]

...

eggs =
    collective.siteimprove

and then running bin/buildout.

Install the Add-on from the Plone Add-ons control panel under Site Setup. Then go to the Siteimprove control panel and request a new token (or paste in an existing one), and save.

Contribute

License

The project is licensed under the GPLv2.

Contributors

  • Jazkarta, info <at> jazkarta.com

  • Witek, witekdev <at> github

  • Alec Mitchell, alecpm <at> gmail.com

  • Sally Kleinfeldt, skleinfeldt <at> jazkarta.com

  • Bert Vanderbauwhede, batlock666 <at> gmail.com

Changelog

1.0.6 (2020-07-09)

  • Add option for public/canonical site url [alecpm]

  • Python 3 compatibility [alecpm]

1.0.5 (2019-11-19)

  • Documentation updates [sallyk]

1.0.4 (2019-11-15)

  • Fix the save and cancel buttons in siteimprove controlpanel [batlock666]

  • Update rolemap to grant Editor and Reviewer role to siteimprove functionality by default [witekdev]

  • Update PYPI classifier. Tested with Plone 5.2

1.0.3 (2018-11-08)

  • Documentation updates [sallyk]

1.0.2 (2018-09-19)

  • Documentation updates [sallyk]

1.0.1 (2018-08-14)

  • Use canonical url for input, domain and recheck functions [witekdev]

  • Call input function on add/edit views, domain on all others [witekdev]

  • Trigger recheck when object saved and publically visible or on any workflow transition [witekdev]

0.1a2 (2018-05-09)

  • Call input method on visible page loads. [alecpm]

0.1a1 (2018-05-09)

  • Initial release. [witekdev]

Metadata

Release files for collective.siteimprove 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for collective.siteimprove 1.0.6
File Size Uploaded
collective.siteimprove-1.0.6.tar.gz 17.2 kB Details

Release files / collective.siteimprove-1.0.6.tar.gz

Download URL collective.siteimprove-1.0.6.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
71fde7fc934323175bee87539c8b4f35d6580f2de17b3c76548895e821f59405
BLAKE2b-256 checksum
How to use checksums
d57a33866b233487b58fb553a43746223d8135cc0b08055546fb63b71fd50000
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page