Adding Revision Log messages allows editors to keep a log of edits made on articles and track edits for future reference in case the article is rolled back to a previous version.
- Adding a revision log when updating an article
- Adding a revision log to a draft
- Adding a comment in the history
- Additional Resources
Adding a revision log when updating an article
- Open the KB (Knowledge Base) article to be edited in TDX, and navigate to the Edit Article button
- Complete the required edits in the TDX article
- Include a comment in the Draft Summary field to describe what edits were made
- The Draft Summary adds the comment to your revision in the history if you click Update Article
- Editors can view revision logs in the History section at the bottom of all KB articles and in the revision section of each article. The revision log will be saved in the history upon updating the article.
Adding a revision log to a draft
Editors can add a revision log to a draft that they do not want to publish yet. Reference Create Drafts and View Article Revisions to learn more about TDX drafts.
- Open the KB article to be edited in TDX, and navigate to the Edit Article button
- Complete the required edits in the TDX article for your draft
- Include a comment, stating what edits were made in the Draft Summary field
- Click Save as Draft
- This saves it as part of the Draft revision.
- Note: When an editor leaves a comment in the Draft Summary, it will remain until the article is updated using the Update Article button. Unless the comment is manually changed, other draft saves will include the exact same draft summary message.
- Editors can view revision logs in the History, at the bottom of all KB articles, and in the revision section of an article.
Adding a comment in the history
If you forget to add a draft summary, you can always add a comment to the relevant revision in the History section of the article.
Additional Resources
Create Drafts and View Article Revisions
Edit the Content of an Article