Create a new Knowledge Base article

Contributors Contributors Last updated: 2 weeks ago
No one has helped translate this article yet. If you already know how localizing for SUMO works, start translating now. If you want to learn how to translate articles for SUMO, please start here.

To create a new article, right-click and open this link in a new tab. The Create a New Knowledge Base Article page will open. Here's what the top part of that page looks like:

new KB

Don't feel overwhelmed by all of the fields and checkboxes when creating a new article and just focus on your content. To get started, here is what you have to do:

  1. Fill out key metadata fields including title, slug, product(s), topic, and search result summary. See Article Metadata and how to edit for more guidance on how to complete these fields.
  2. Go to the Content box and start writing!
    blank KB editor
  3. Click Preview Content to see what your article will look like when it’s been published.
  4. Be sure to double check on the other details (title, slug, product, topic, etc) before clicking on the Submit button. When you’re satisfied with your article's content and appearance, click Submit for Review.
  5. Briefly describe your changes in the Submit your Changes box that appears. If you have more work to do, you can type in “Work in progress”.
    Submit revision dialog
  6. Click Submit.

The code below is an example of how text might appear in the content section of an article, using the most common wiki markup. For an explanation of common markup used in KB articles, see the Markup cheat sheet. For lots more markup, see the Markup chart.

Introduction goes here.

__TOC__

=First section=
An unordered list:
*First item. For more information, see [[Name of article]]
*[[Name of article|Second item]]
*:[[Image:Name of image]]

{note}'''Note:''' This is an example of a note.{/note}

=Second section=
{for win}
A numbered list only "for" Windows users:
#First item
#Second item
{/for}

{for mac}
A numbered list only "for" Mac users:
#First item
#Second item
{/for}

{for linux}
A numbered list only "for" Linux users:
#First item
#Second item
{/for}

{warning}'''Warning:''' This is an example of a warning.{/warning}

These fine people helped write this article:

Illustration of hands

Volunteer

Grow and share your expertise with others. Answer questions and improve our knowledge base.

Learn More