> ## Documentation Index
> Fetch the complete documentation index at: https://devs.surferseo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Surfer in Contentful

> Write Contentful entries with Surfer's guidelines in the entry sidebar.

Check the plan and space requirements below, then install Surfer's app in your Contentful space. Every entry of the content types you choose gets the Surfer panel in its sidebar. The panel shows a [Content Editor](/integrations/guidelines-panel), the document Surfer builds around your target keywords, holding the guidelines and the Content Score.

## Availability

The Pro, Peace of Mind, and Enterprise plans and the trial include the integration. Some older plans include it too.

If your plan excludes the integration, the panel shows `Contentful integration is not available on your plan`. On an entry without a Content Editor, the message replaces the list of Content Editors. See [Plans](/integrations/guidelines-panel#plans) for the panel's own plan and subscription messages.

## Before you start

Check four things before you install the app:

* A Contentful space where you have permission to install apps.
* A Rich Text field on every content type you want Surfer on. The app reads only Rich Text fields, and its configuration screen cannot switch on a content type without one.
* A Surfer account with an active subscription, signed in to the app in the same browser. The Surfer and Contentful accounts do not need to match.
* A browser that lets Surfer use its cookies inside Contentful. [Sign in and cookies](/integrations/guidelines-panel#sign-in-and-cookies) explains the setting.

The app loads the panel without a browser extension.

## Install the app

Installation runs through Contentful's Marketplace and ends on the app's configuration screen. There you choose the content types and fields.

**1. Open the Marketplace**

In Contentful, go to **Apps → Marketplace**, or open [Surfer's
listing](https://www.contentful.com/marketplace/app/surfer/) directly.

**2. Find Surfer**

Open Surfer's listing.

**3. Install**

Select **Install**. The app's configuration screen opens.

**4. Choose the content types**

Under **Select content types and fields**, every content type with a Rich
Text field starts switched on. Switch off the ones that should not get the
panel. A content type without a Rich Text field stays off, with the tooltip
`This content type doesn't contain any RichText fields`.

**5. Choose the fields**

Under each switched-on content type, its Rich Text fields are listed. All of
them start switched on. Switch off any field the score should ignore.
Switching off the last switched-on field switches the content type off.

**6. Finish the installation**

Select **Install** in the top bar. Surfer appears in your list of installed
apps under **Apps**.

![The Surfer app's configuration screen in Contentful with two content types switched on, their Rich Text fields listed under them, one content type disabled, and the Install button in the top bar.](https://mintcdn.com/surfer-1a8fda11/P3XHkcSM3gsec1Io/images/integrations/contentful/contentful-install.png?fit=max\&auto=format\&n=P3XHkcSM3gsec1Io\&q=85\&s=077aa5b8a8633cdb5c451332865b2bca)

To change the selection later, open the app again from **Apps**. The configuration screen shows your current choices. Its top bar offers **Save** in place of **Install**.

## Add Surfer to a content type's sidebar

Installing the app puts Surfer in the sidebar of every content type you switched on. Add it by hand only if an entry of a switched-on content type shows no panel, for example after you rearranged that sidebar.

**1. Open the content type**

Under **Content Model**, open the content type.

**2. Open the sidebar settings**

Open the **Sidebar** section.

**3. Add Surfer**

Select the plus sign next to Surfer in the list of available items.

**4. Save**

Select **Save**.

![A content type's Sidebar section in Contentful with Surfer added to the sidebar items and the Save button.](https://mintcdn.com/surfer-1a8fda11/P3XHkcSM3gsec1Io/images/integrations/contentful/contentful-sidebar-config.png?fit=max\&auto=format\&n=P3XHkcSM3gsec1Io\&q=85\&s=4751c89fa0b32b7322d9e12f72a6e60d)

## Write with the guidelines

Open an entry of a switched-on content type. The Surfer panel sits in the right sidebar. The **Collapse** button above it folds the panel away, and **Expand** brings it back.

On an entry that has no Content Editor yet, the panel lists your Content Editors. A Content Editor whose analysis is still running cannot be picked. Linking one replaces any document it was linked to before, as [The dashboard](/integrations/guidelines-panel#the-dashboard) on the guidelines panel page explains.

Pick a Content Editor to link it to the entry, or create a new one. Creating one spends one Content Editor credit, a credit from your plan's balance. See [Credits](/integrations/guidelines-panel#credits) for the full rule.

The link belongs to the entry, so everyone who opens that entry sees the same Content Editor.

The score reads the Rich Text fields you switched on for that content type, together as one text. Other fields are not read, including the title. A Rich Text field added to the content type later is not read until you switch it on from **Apps**.

**Customize**, the gear in the panel's header or the entry at the top of its dots menu when the sidebar is narrow, opens the Content Editor's settings in Surfer in a new tab. See the [guidelines panel](/integrations/guidelines-panel#what-the-panel-shows) page for what the panel shows and what stays in the Surfer app.

![A Contentful entry with the Surfer panel open in its right sidebar, showing the Content Score and the guidelines for the entry's Rich Text field.](https://mintcdn.com/surfer-1a8fda11/P3XHkcSM3gsec1Io/images/integrations/contentful/contentful-entry-panel.png?fit=max\&auto=format\&n=P3XHkcSM3gsec1Io\&q=85\&s=43a817e8fbc1ebaf8c2aad2ea580f155)

## In the Surfer app

In Surfer, the linked Content Editor shows **Editing happens in Contentful** in place of its editor. There is no button to open the entry, because Contentful entries have no public address. Its other buttons and what disconnecting restores are on [The linked Content Editor in the app](/integrations/guidelines-panel#the-linked-content-editor-in-the-app).

## Verify it is working

The panel shows the Content Score and the guidelines for the entry, and both follow the switched-on fields as you type.

1. Open an entry of a switched-on content type.
2. If the panel lists Content Editors, pick one.
3. Type a sentence in a switched-on Rich Text field.
4. Watch the word count in the structure strip at the bottom of the **Guidelines** tab go up.

## Remove the app

Uninstalling removes the panel from every entry. The Content Editors it linked stay linked in Surfer until you disconnect them there.

1. In Contentful, go to **Apps**.
2. Uninstall Surfer from your installed apps.
3. In Surfer, [disconnect each linked Content Editor](/integrations/guidelines-panel#the-linked-content-editor-in-the-app) to edit it in Surfer again.

To take Surfer off one content type and keep the rest, remove it from that content type's **Sidebar** section and select **Save**.

## Troubleshooting

Start in Contentful's content model. Check that the entry's content type has a Rich Text field and that Surfer is switched on for it.

> **The sidebar asks for a Rich Text field**
>
> The entry's content type has no Rich Text field, so the sidebar shows `Add a
>         RichText field to enable Surfer!` in place of the panel.
>
> 1. In **Content Model**, add a Rich Text field to the content type.
> 2. Open the app from **Apps**.
> 3. Switch on the content type. Its Rich Text fields switch on with it.
> 4. Select **Save**.

> **The panel asks you to sign in**
>
> You are signed out of Surfer, or you are signed in and the browser blocks
> Surfer's cookies inside Contentful. Follow [Sign in and
> cookies](/integrations/guidelines-panel#sign-in-and-cookies) for either
> case. You can use different accounts for Surfer and Contentful.

> **The panel says the integration is not available on your plan**
>
> The organization's plan does not include the integration. See
> [Availability](#availability) for the plans that include it. For an entry
> that already has a Content Editor,
> [Plans](/integrations/guidelines-panel#plans) on the guidelines panel page
> explains what the panel still shows.

> **No Surfer panel appears on an entry**
>
> Either the content type was switched off when the app was installed, or
> Surfer is missing from its sidebar.
>
> 1. Open the app from **Apps**.
> 2. If the content type is switched off, switch it on and select **Save**.
> 3. Under **Content Model**, open the content type's **Sidebar** section.
> 4. If Surfer is not listed there, [add Surfer](#add-surfer-to-a-content-types-sidebar).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.