1
0
Fork 0
tuned/doc/tuned-documentation
2019-01-04 18:20:14 +01:00
..
assemblies Added user-facing documentation: initial commit 2019-01-04 18:08:28 +01:00
meta Added user-facing documentation: initial commit 2019-01-04 18:08:28 +01:00
modules/performance Added user-facing documentation: initial commit 2019-01-04 18:08:28 +01:00
master.adoc Added user-facing documentation: initial commit 2019-01-04 18:08:28 +01:00
README.adoc Added a readme for documentation 2019-01-04 18:20:14 +01:00

= About this documentation

This directory contains source files of Tuned documentation intended for system administrators.

== Building the source

The documentation is written in the *AsciiDoc* markup language. To build it, install the link:https://asciidoctor.org/[asciidoctor] utility and use it to convert the master file:

----
$ asciidoctor doc/tuned-documentation/master.adoc
----

This generates the `master.html` file, which you can open with your web browser.

== Structure

The `master.adoc` file is the main entry point for the documentation. It _includes_ (or, imports, loads) _assembly_ files from the `assemblies/` directory, which represent user stories. These assembly files then include _modules_ located in `modules/performance/`. Modules are reusable sections of content representing a concept, a procedure, or a reference.