Most small open source documentation projects use Markdown to create their project documentation. After all, it has a minimalistic and thus easy-to-learn syntax, does all the basics well, renders very quickly (even quickly enough to create a real-time WYSIWYG viewer), and is almost universally supported across popular web platforms like GitHub. At some point, though,…
Read MoreThe official Icinga 2 user guide is quite extensive, but it’s not always complete. That’s normal in today’s world of fast changing software where the focus is on delivering new capabilities quickly. Even here at NetEye most of the documentation we produce for our user guide is written when we add new modules and features,…
Read MoreEvery software suite needs documentation. But the more features we add to NetEye to meet customer needs, the larger the user guide becomes. Over time, it’s important to make sure that the guide continues to meet the needs of NetEye users despite this. In particular, modern methodologies like Agile that we use in NetEye often…
Read MoreIn my last user guide blog I showed you how to create your own menu item, create a space on the file system, write a sample page, and store an image for that page, all in a way that will survive future updates. This time I want to show you how to use your custom…
Read MoreIn my last post, I showed you how to set up your own customized documentation in NetEye 3 so that it won’t be overwritten when you upgrade. Doing the same thing in NetEye 4 is also possible even though there isn’t a dedicated link for external documentation like in NetEye 3’s DokuWiki, and there isn’t…
Read MoreWouldn’t it be great to have quick access to your favorite pages in the NetEye documentation? To make customized thumbnail pages of your most frequent screenshots? To create your own alternative documentation index with categories reflecting your mindset? To add your own notes, comments, or FAQ with pointers into the existing NetEye documentation? That would…
Read More