Page tree
Skip to end of metadata
Go to start of metadata

The Siteimprove connector enables you to perform SEO checks by using the cloud-based application Siteimprove. It is a tool to help you score a higher ranking in search engines and check how your content is performing overall.

Status INCUBATOR
TypeConnector
SubJar
JIRASIMPROVE
Gitsiteimprove

Installation

Maven is the easiest way to install the modules. Add the following dependencies to your bundle:

<dependency>
    <groupId>info.magnolia.seo</groupId>
    <artifactId>magnolia-siteimprove</artifactId>
    <version>${siteImproveVersion}</version>
</dependency>

Versions

1.0.4Magnolia 5.6.5

Usage

Using the Siteimprove connector is meant to help you fix and improve website accessibility, SEO, content quality and more. Siteimprove crawls websites through their public URLs, which means that all pages are indexed from their public addresses.

Configuration

The module provides two configuration options.

mapperClass

optional, defaults to info.magnolia.connector.siteimprove.mapper.SiteDefinitionDomainMapper

The default mapping implementation relies on the related site definition domain. You can add your custom implementation of the page mapping by implementing info.magnolia.connector.siteimprove.mapper.SiteImproveMapper and changing the related configuration.

token

required

Token provided by Siteimprove. The first time Siteimprove is contacted the token is stored here. There is no need to set the token manually.

Siteimprove Dashboard

To access the Siteimprove dashboard, open the Pages app, find and double-click to edit the site/tree/page, and click on the Siteimprove icon around the actionbar area. A small window on the right side of admincentral will then open and display the Siteimprove dashboard showing SEO results of the currently opened page.

If it is your first time accessing the dashboard, you will be prompted to enter your Siteimprove credentials.


Performing an SEO Check

To perform an SEO check to a site/tree/page, click on the Re-check page action in the Siteimprove dashboard within Magnolia's admincentral. Siteimprove will then analyze the page's content and will display results such as the DCI page score, number of broken links, misspellings and more.

Before any SEO check could be performed, the website must first be set to be observed by Siteimprove. This can be done in the Siteimprove application itself.


Warnings

  • This module is at INCUBATOR level.

Changelog

  • Version 1.0.4
  • Version 1.0.3 - Initial release of the extensions version of the module.