Edit a Knowledge Base article
Revision Information
- Revision id: 228160
- Created:
- Creator: Kiki
- Comment: Adding complete KB guidelines
- Reviewed: Yes
- Reviewed:
- Reviewed by: AliceWyman
- Is approved? No
- Is current revision? No
- Ready for localization: No
Revision Source
Revision Content
Keeping Knowledge Base articles up-to-date and error-free are crucial tasks for knowledge base editors. Here's how to edit an article:
Table of Contents
Open the Editing page
Sign in to Mozilla Support, find an article you wish to edit and find Editing Tools on the top right side of the page.
Choose one of these methods to open the article's Editing page:
- To base your edit on the currently approved article revision, click under Editing Tools.
- To base your edit on a previous revision or a pending, unreviewed revision, click under Editing Tools and click the pencil icon next to the revision you wish to edit.
- For archived articles, click under Editing Tools, click the Revision date and click Edit article based on this revision.
Edit Content
To edit the content of an article:
- Make your changes in the Content: text box of the Editing page.
- Click or at the bottom of the page, if you wish, then
- Click .
- In the Submit Your Changes dialog box that appears, describe your changes and click
. - Wait for a reviewer to approve your changes.
Keywords (reviewers only)
If you have permission to review articles, the Edit Content section will include a Keywords field for improving search results. See When and how to use keywords to improve an article's search ranking.
Edit Description (reviewers only)
If you have permission to review articles, the Editing page will include an unexpanded Edit Description section above Edit Content.
Click on Edit Description to expand the section.
This is where you can
- Change an article's title, slug, category, topics, Relevant to: product and related documents
- Archive or un-archive an article (Obsolete: checkbox)
- See above for how to open the Editing page to un-archive an article.
- Add or remove a Needs change: entry or comment
After making your changes, click
; otherwise, your changes will not be saved. After saving your Description edits, you can then make any needed edits to the article content.Complete Knowledge Base Guidelines
If you're really interested in editing and writing documentation, here are a few resources that should help explain how we do things:
Create new support articles
- Writing guide for Knowledge Base articles — Guide to writing techniques and styles that we use to make articles more engaging and effective. For the mechanics of actually creating or editing articles, see:
- Create a new Knowledge Base article – Steps for creating a new article along with some sample wiki markup to get you started
- Anatomy of a Knowledge Base article – Explains the basics of how articles are built
- Article Description - Explains how to write description for a support article
Improve existing support articles
- Improve the Knowledge Base - Learn how to improve SUMO Knowledge Base
- Edit a Knowledge Base article - Steps for editing an existing article (You're here!)
Other guidelines
- About the Knowledge Base — An overview of the mechanics of our Knowledge Base
- Article review and approval guidelines - Reviewer guidelines for Knowledge Base
- How to make screenshots — A step-by-step guide to creating screenshots to use in articles
- Add images and screenshots to Knowledge Base articles — Explains how to add screenshots to articles
- Add images and screenshots to Knowledge Base articles — Explains how to get screenshots and other images to display correctly in articles
- Markup cheat sheet – The most commonly used wiki markup in our articles
- Markup chart — Wiki markup reference. It gives examples and shows the markup that produces them
- How to use {for} — Special wiki markup that lets us show instructions for different application versions (for example, Firefox 40) and operating systems such as Windows and Mac OS
- Using Templates — Templates are reusable pieces of content. You can include a complicated set of step-by-step instructions in multiple articles by using a template.
- When and how to use keywords to improve an article's search ranking — Explains when adding keywords to an article is appropriate
- To see more guidelines on Knowledge Base contribution, click here