nikon/tuned
1
0
Fork 0
Code Activity Actions

Added a readme for documentation

Browse source
This commit is contained in:
Marek Suchánek 2019-01-04 18:20:14 +01:00
parent 1a2e13e44f
commit de099c1556
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/tuned-documentation/README.adoc Normal file
View file

@ -0,0 +1,18 @@
= 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.