Product documentation
This is an in-depth guide on how to use our documentation platform based on BookStack.
Welcome to the SITS Product Documentation!
On these pages you can find general information about our software products, manuals, releases notes and artifacts.
Onboarding
Structure
This product documentation platform is based on BookStack, which uses the hierarchical structure of a library to categorize content:
- Shelves: Product families which consist of individual products that are intended to be combined (e.g. true-Xtender, true-Sign)
- Books: Single product containing manuals, releases and more (e.g. true-Xtender Registration Authority, true-Sign Crypto Service)
- Chapters: A collection of the same document type available for different product versions (e.g. Manuals, Releases)
- Pages: The individual document containing content of a product about a specific version (e.g. Introduction, User Manual V-1.0.0, Release V-1.0.0)
Tutorial
We recommend taking a look at our documentation of this platform to discover all the features it has to offer and how to use them. Check out the Features section below for a quick overview of what this platform has to offer.
Features
Security advisory
The security advisory contains security-relevant information for our products.
Product documentation
Installation manuals, user guides, release notes and more for various versions will be available for customers with a valid license.
Software downloads
Current versions of our products will be downloadable from Release chapters for customers with a valid license.
Page revisions and exports
Previous page versions are kept accessible as revisions and self-contained copies can be exported to a variety of formats.
Email Notifications
Changes within pages or whole chapters can be tracked by enabling the watch function which will send a notification email.
Public content
The platform also contains high-level information about our other products, which is publicly accessible.
Contacts
If you need more information or want to reach out, feel free to contact us via any of the following channels:
Navigation
Header
The header contains the main navigation elements:
From left to right:
- The SITS logo redirects to the landing page
- A search bar which searches for keywords in all accessible pages
- The Shelves button leading to the listing of all product families
- The Books button showing all available products in a single list
- The Log in button for authenticating users and authorizing them to view specific content
Page actions
The page actions are located on the right sidebar and offer additional functionality for this page:
Revisions
Revisions list previous page versions. Revisions are created when content of page is updated.
Export
Each accessible page can be exported to be used in an environment where no internet access is available. The following formats are offered:
Structure
Each product documentation is structured in the same manner to allow for quick retrieval of information. Here is an
example of the Autoenroll PKI documentation page:
Introduction
The introduction is one of the publicly accessible pages and aims to showcase features of the product.
Releases
The releases chapter contains a number of releases structured as pages. Each page title contains the product version. The page contains the release notes for this version and downloadable attachments like software releases, SBOMs and more.
Guides and Manuals
Much like releases, guides and manuals are also contained in chapters as versioned pages. A page with a version in the name can also have different revisions.
- The title version indicates to which software release the page belongs to.
- The page revision represents the current state of this page for this particular software version. It might increase when mistakes in the documentation are fixed.