Documentation
- Chris Sinkinson (Unlicensed)
AppArmor provides detailed documentation on all aspects of our system. The documentation interface is designed with three main components:
Search Interface: Allows quick searching of the product documentation
Table of Contents: Shows the hierarchy of the documentation, which mimics the user interface of the systems
Content Interface: Shows the title, details, and content for each article
Documentation Structure
The product documentation is a hierarchy of information. The three headings below are AppArmor company information:
About AppArmor: Details about AppArmor including copyright statements and information about our product lines
Announcements: Product enhancement announcements
Customer Support: Information about our support plans, and how to access support
The remaining headings in the table of content are system specific; “Dashboard”, “Mobile App” etc. The content below these headings are designed to follow the logical layout of each system. This should allow you to quickly navigate the support information to find answers.
Searching Documentation
The documentation search tools allows you to quickly find content by keyword. Just enter some keywords and the search tool will perform a “fuzzy” keyword search to find relevant documentation and display based on ranking.
Hiding the table of contents
Sometimes it is desirable to have more space for the content of the article by hiding the table of contents. There is a button that can be used to hide the table of contents.
Showing the table of contents
To show the table of contents again, click the “Show TOC” link near the title of the article.
Viewing larger version of images
Clicking on any image in the documentation viewer will pop out a full size version of the image. Click the “X” in the top right corner to return the image to normal size.