Kentico/xperience-by-kentico-siteimprove

An integration with Siteimprove that allows users to check website and pages for issues directly from Xperience by Kentico

Xperience by Kentico Siteimprove

About The Project

Xperience by Kentico Siteimprove integration allows users to check pages for issues directly from Xperience by Kentico.

Getting Started

Prerequisites

• Xperience by Kentico >= 26.0.0

Installation

1. Add project reference

Setup of CMS Plugin

By following the steps below, the integration setups automatically on the first startup.

1. In Program.cs, register services and map routes by adding

   WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
   
   ...
   builder.Services.AddKentico();
   builder.Services.AddSiteimprove(builder.Configuration);
   
   ...
   WebApplication app = builder.Build();
   
   ...
   app.UseKentico();
   app.UseSiteimprove();

2. In Views/_ViewImports.cshtml, add Tag Helper

   @using Kentico.Xperience.Siteimprove
   @addTagHelper *, Kentico.Xperience.Siteimprove

3. In Views/Shared/_Layout.cshtml, place the Tag Helper to a suitable location

   <page-builder-scripts />
   <siteimprove-plugin />

4. In your appsettings.json, add section

   "xperience.siteimprove": {
     "APIUser": "<Siteimprove API user>",
     "APIKey": "<Siteimprove API key>",
     "EnableContentCheck" : "<true/false>" // set this to true if you are subscribed to Prepublish feature
   }

Setup of CMS Deeplink

1. In Program.cs, register services by adding

   WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
   
   ...
   builder.Services.AddKentico();
   builder.Services.AddSiteimprove(builder.Configuration);

2. In Views/_ViewImports.cshtml, add Tag Helper

   @using Kentico.Xperience.Siteimprove
   @addTagHelper *, Kentico.Xperience.Siteimprove

3. In Views/Shared/_Layout.cshtml, place the Tag Helper inside the head tag

   <page-builder-styles />
   <siteimprove-deeplink />

Usage

CMS Plugin

The plugin is accessible only from Preview mode in the Pages application.

Pages are automatically rechecked when republished to ensure the plugin displays up-to-date information.

CMS Deeplink

Meta tag is added to the head of each page to allow for easier setup of CMS Deeplink on Siteimprove's side. The meta tag follows pattern recommended by Siteimprove:

<meta name="pageID" content="<pageID>" />

Contributing

For Contributing please see CONTRIBUTING.md for more information and follow the CODE_OF_CONDUCT

Requirements

• .NET 7+ SDK

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This contribution has Kentico Labs limited support.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.