About OpenIndiana Docs

This website and its content uses a number of different technologies:

History of OpenIndiana Docs

The current documentation revitalization effort began in late 2015. For some time the project recognized it needed to do a better job of organizing and presenting end user documentation. Just as important, it also recognized how documentation needed to more accurately follow the development state of OpenIndiana Hipster.

The docs team began by looking at:

Documentation revitalization effort goals

As a result of the aforementioned exercises, the team established the following goals:

To this end, the team looked at several documentation oriented static site generators and selected MkDocs for its simplicity, ease of use, and professional quality output.

Using the OpenIndiana Docs website

The OI-DOCS website can be navigated in several ways:

NOTE:

The table of contents lists top level sectional titles only.

To find lower level sectional titles, or to search for topics by keyword, please use the full text search function of the website. The full text search will return a list of the sectional titles where the keyword has been found.

Contributing to OpenIndiana Docs

First and foremost, we understand using development tools and techniques to write end user documentation is not for everyone. For this reason, we're happy to accept your contribution in any format you wish to provide.

After receiving your submission, we will review the document for conversion to markdown and subsequent incorporation into OpenIndiana Docs. Contributions may be submitted in plain text, .doc, .docx, .odt, html, xml, latex, pdf, GitHub Gist, etc.

In summary, if you believe your contribution would be helpful to the greater OpenIndiana community, we'll be willing to review it. For further information, please see the contribution pages found elsewhere on this site.

Providing feedback

Community feedback is critical to the growth and development of the OpenIndiana Docs website.

To make a suggestion or report a problem with a document, please make your request by submitting a Github issue.

The docs team can be reached via email: docs at openindiana.org.

You may also inquire via IRC: