No matches found

Content Model Overview

In the Content Model tab, you’ll find a sample content model already created for your use. This content model is the basic structure of your knowledge base. You can edit the content model as desired, but note that any changes will require additional engineering support. The content model for this app is as follows:

Site settings

The Site settings content type is where the master settings for your knowledge base are located. All changes made to this content type are reflected globally. There must only be one Site settings entry in your space. 

The Site settings content type contains the following fields:

  • Site name (SEO) (short text): The name of your website as it will appear in search results.

  • Site description (SEO) (short text): A description of your website as it will appear in search results.

  • Logo (media): The logo you want displayed in the help center site header. Maximum width is 160 px (height is proportional). Maximum size is 2 GB.

  • Heading (short text): The heading to be displayed on your help center home page

  • Subheading (short text): Subheading to be displayed beneath the home page heading

  • Navigation links (references): Links to be displayed in the site header. Maximum of 3. See Links section below for more information.

The Link content type creates links for your knowledge base. These can be used for navigation links in the header, for example. You can customize the display text, set the destination URL and set the icon to one of your choosing. Reference this entry type in your Site settings content type to make global changes.

The Link content type contains the following fields:

  • Display text: The text you want to link

  • Href: The url you want to link to

Category

The Category content type organizes entries by topic. Your app space comes with two pre-existing categories called “Getting Started” and "Content Model Overview". These categories can be edited or removed. You can also create your own categories. Articles can be linked to a Category to group them as desired. By default, Categories will be displayed as an alphabetical list on your home page.

The Category content type contains the following fields:

  • Name (short text): The desired name of your category

  • Slug (short text): The desired URL for your category. Once a category is published, this should not be changed

  • Description (Long text): A description of what the category contains

Article

The Article content type creates entries for knowledge base articles. Articles can be in three states: draft, published or changed:

  • Draft articles can only be accessed within Contentful

  • Published articles are “live” and publicly available in the knowledge base

  • Changed articles are published articles that have been edited, but those changes are not yet published. These changes are not visible outside of Contentful until the article is published again

Articles can be formatted with any of the options available in RichText. Sidebar links are automatically generated based on the heading size you use (H1, H2, etc.). 

The Article content type contains the following fields:

  • Title (short text): Title of your article. Will be displayed at the top of the page.

  • Slug (short text): The URL for your article. Once an article is published, this should not be changed

  • Meta Description (long text): Short description of article contents. Will be seen in search results, social media posts, Slack messages, etc.

  • Body (RichText field): The main body for your article. All standard RichText formatting options are available

  • Category (Reference): Before an article can be published, it must be linked to a Category

Code block

The Code block content type creates code blocks that you can use in your articles.

The Code block content type contains the following fields:

  • Name (short text): Title of your code block.

  • Language (dropdown): The language of your code. It is used for the better syntax highlighting.

  • Code (long text): Code of your your code bock.

Find out more on how to embed code blocks page.