About this Documentation¶
orcharhino is a large software suite that emphasizes user choice and vendor independence. As a result orcharhino often supports multiple solutions, even for a single type of feature. For example, orcharhino supports the use of Puppet, Ansible, or SaltStack for its configuration management.
Keeping this in mind, not every aspect of orcharhino will be of equal interest to all users and this documentation is not primarily intended to be read from front to back. (Though motivated readers may of course do so!)
This section of the Introduction serves to illustrate how to approach reading this documentation, it’s structure and where we plan to take it in the future.
Section Structure and References¶
This documentation uses headings of different levels to provide structure. Throughout this documentation we refer to top level headings as chapters, second level headings as sections, third level headings as subsections, and fourth level headings as subsubsections. For example, you are currently reading the Section Structure and References subsection, of the About this Documentation section, of the Introduction chapter.
Depending on context, the term section can also be used to refer to everything contained in a single heading of arbitrary level. For example, the following section (to this one), is the Entry Points subsection.
In addition this documentation makes ubiquitous use of references (links) to the various section headings. Each section header in the previous two examples is a link to the relevant section. References allow readers to “follow” some topic of interest around the documentation, and help to avoid duplicate documentation.
Each section in the Usage Guides chapter is dedicated to a self contained topic of interest on some individual aspect of orcharhino. Each such “usage guide” can be read if and when it becomes relevant to a particular reader’s orcharhino usage. Each individual “usage guide” is intended to be read from front to back.
The Plugin Guides chapter is dedicated to optional plugins that can be installed to extend orcharhino’s feature set. Each such “plugin guide” will generally include installation steps, as well as a short description on what the plugin does and how it is used.
By contrast the structure of the Management UI chapter, closely shadows the structure of the orcharhino web interface. Each orcharhino menu, is given it’s own section, and each menu entry is given it’s own subsection. These sections are intended to be linked to directly from the orcharhino web interface (not yet implemented). As such, each page in this chapter seeks to be a viable entry point for reading the documentation. Ultimately, the Management UI chapter should provide detailed documentation, on every page, button and action, that can be accessed through orcharhino’s web interface.
The Troubleshooting chapter contains instructions for topics relating to orcharhino troubleshooting (like logging and background services).
Writing documentation is a time consuming process, and as of this writing not every aspect of this documentation is as detailed as we would ultimately like. We are actively working to extend it with additional content (as well as greater detail for existing content). We apologize for any inconvenience, and ask that this documentation be read as a living document.
The following list details our immediate plans for coming releases of this documentation:
- Adding a complete Compute Resources Guide
- Adding a complete Remote Execution Guide
- Adding a complete Smart Proxy Guide
- Adding a “Puppet Guide”
- Adding more detail to the Management UI chapter
- Documenting additional orcharhino plugins
Long-term goals (no promises) include: