KB User's Guide - Settings Tab - Requiring Review Comments

NoteInformation symbol

You must have full administrative permissions in your space to perform these steps. This means access to the Documents, Settings, and Users tabs.

By default, authors are not required to enter a comment prior to editing an active document. This document describes how to change that setting for your group space so that comments are required.

  1. In the KB Admin Tools, go to the Site Pref tab and click on Group Spaces in the side navigation. Your KB group space should be the first group listed in the table. Click on the Edit button for your group's entry in the table.

    Your group will be in the first row of the table, and the edit button is located in the third column.

  2. This will take you to a screen of settings for your KB group. Scroll down to the "Documentation Settings" section. The fifth setting in this section is Require doc review comment. By default, this will be set to "No". Changing this has the following effects:

    The require doc review comment field uses a dropdown menu to change the setting from no to yes

    • No: Comments are optional when changing a document from Active to In Progress, and they will always see an "Edit" button when viewing a document in the KB Admin Tools. Authors will still be able to enter a comment if desired.

    • Yes: Authors will not be able to change a document from Active to In Progress unless text has been entered into the "Comment" field before clicking "Submit" to edit. They will only see an "Edit" button when viewing a document in the KB Admin Tools if the document is already In Progress or In Review.


Keywords:
sitepref site preferences tab users guide kb knowledge base review comments Require doc review comment other options 
Doc ID:
8956
Owned by:
Leah S. in KB User's Guide
Created:
2009-01-29
Updated:
2023-08-24
Sites:
KB User's Guide