Documentation¶
-
Administrator Guide - set up and manage DRP
Install, configure, upgrade, and maintain DRP.
-
Architect Guide - learning starts here
Learn the features and methodology of DRP.
-
Developer Guide - building automation
Build your own automation and integrations for DRP.
-
Operator Guide - driving the system
Manage the machine lifecycle for maximum effect.
-
Resources - reference and information
Object models, CLI reference, knowledge base, and release information.
Documentation Styles¶
RackN documentation follows the the Diataxis and Divio methodology. A consise summary is that there are four types of documentation.
- Explanations- Articles or sections that describe the intent and methodology of a part of the product. These provide information from a perspective understanding the product.
- How-To - Articles or sections that describe how something could be done. These provide methods for implementing features from a perspective of learning how to extend or expand the product.
- Tutorials - Articles or sections that describe the specific actions to do something with the product. These provide steps or actions to a specific thing from a perspective if operating the specifics of the product.
- References - Articles or sections that describe the specifics of a part of the product. These provide information from a perspective of looking up a fact or specific detail of the product.
The articles are tagged and grouped to make it easier to see there fit into the scheme.
Documentation Audiences¶
Documentation needs an audience. RackN Documentation defines four audiences.
- Administrator - Articles or sections intended for those who install, configure, upgrade, and maintain DRP. These cover the DRP lifecycle: installation, networking, auth, HA, and licensing.
- Architect - Articles or sections intended for architectural discussions. These are generally explanation articles for learning how the system works and why.
- Operator - Articles or sections intended for the operators of the product. These focus on the machine lifecycle: discovery, provisioning, and decommission.
- Developer - Articles or sections intended for developers building automation, extending current tooling, or integrating the product into their environment.
The articles are tagged and grouped to make it easier to see their fit into the scheme.
Using the Documentation¶
The tags help direct you understand the audience and content style, but search provides the methods to find what you are looking for. A couple of tips can help get more from your searching.
tags are included
Tags are included in the search indexes. By using a tag, you will get those pages that have that tag listed first in the search list. It allows for a fast filtering.
+ means required
By prepending a + to the term, it makes the term required for the search. Using this with tags, allows for restricting the first results
to just that set of pages. Adding additional terms makes the search more specific.