Documentation

The Documentation feature allows for storing information about resources in the data source. To access an entry's documentation, select an entry in the Navigation pane, then select the Documentation tab in the Dashboard. Alternatively, right-click an entry in the Navigation pane, then select View – Documentation.

The documentation is written using Markdown or WYSIWYG. Plain text and HTML are also available.

This feature is also available with Devolutions Server, Devolutions Hub Business, Devolutions Hub Personal and SQL Server data sources.

The Documentation feature is encrypted only for Devolutions Server, Devolutions Hub Business, and Devolutions Hub Personal data sources. If you are using data sources like SQL Server or Azure SQL, the Documentation feature is not encrypted.

The feature for using Documentation in offline mode is available for documents that are stored in the database. This property is set to be inherited by default.

Create a new page

  1. Choose the entry in the Navigation pane.

  2. Go to the Documentation tab and click New page.

    Documentation tab – New page
    Documentation tab – New page

  3. Enter a name and select a Documentation type.

    Documentation type
    Documentation type
    Note: You can switch between Markdown and WYSIWYG when you select Markdown in Documentation type.
    Markdown and WYSIWYG
    Markdown and WYSIWYG

  4. Choose a Default template.

    Default template
    Default template

    Tutorial creates a document containing generated text and Empty a blank document. The last option, Custom, lets you select a custom template of your choice.

    You can select Set as new default to save your preferences when you create a new document and Add as last page to insert the new page at the bottom of the file list.

  5. Click OK to close the window.

Synchronize offline documentation

  1. Choose the entry in the Navigation pane.
  2. Go to Administration – Vault Settings in the ribbon.
    Vault Settings
    Vault Settings
  3. In Security Settings – Offline – Synchronize documentation to offline, select Yes.
    Synchronize documentation to offline
    Synchronize documentation to offline
  4. Click OK and close the window.

The offline Documentation tab is now available in the Dashboard.

Documentation tab
Documentation tab

Synchronize offline document

  1. Choose the entry in the Navigation pane.
  2. Go to Administration – Vault Settings.
    Vault Settings
    Vault Settings
  3. In Security Settings – Offline – Synchronize document to offline, select Yes.
  4. Click OK and close the window.
    Synchronize document to offline
    Synchronize document to offline
    The offline Documentation tab is now available in the Dashboard.
    Documentation tab
    Documentation tab