When you work with hundreds or thousands of entries, things can get chaotic. It can be difficult (sometimes impossible) to remember the function of each entry, and training new employees to use entries properly is time-consuming — and therefore costly. Well, help has arrived in the form of the new Documentation Editor!
The Documentation Editor is a powerful, yet lightweight and simple-to-use text editor that lets you document entries directly in Remote Desktop Manager (RDM), without having to add a new entry (such as a text document). You can add any information that you wish, such as instructions, reminders, troubleshooting tips, and so on.
Currently, the Documentation Editor is available in RDM with SQL Server and Devolutions Server data sources. We are currently working on making it available for the Devolutions Server Web Interface, and will be releasing this very soon.
To access the Documentation Editor, simply select an entry in the navigation pane, and then choose the documentation tab in the dashboard.
The Documentation Editor uses markdown, which is an easy-to-read and easy-to-write plain text format for quickly creating content, which then translates easily into structurally valid formats (e.g. HTML). Markdown is very simple and doesn’t create proprietary document formatting headaches, which is why platforms like Reddit support it for posts and comments.
For instance, # [Text] formats the text as a header, and **[Text]** makes bold text. Syntax possibilities include:
- Code examples
- Multiple pages
- Horizontal Rules
- ...and the list goes on.
Also, don’t worry if your document has unwanted changes or errors. The Documentation Editor supports full revision history, and you can revert to earlier versions anytime. Also, it's going to be supported in Devolutions Server (DVLS) 5.
We hope you enjoy the Documentation Editor, and that it helps you tame the chaos in your world.
As always, please let us know your thoughts by using the comment feature of the blog. You can also visit our forums to get help and submit feature requests, you can find them here.