Skip to content
Branch: master
Find file History
yarda doc: renamed doc/guide to doc/manual
After team discussion we decided to rename it to manual.

Signed-off-by: Jaroslav Škarvada <jskarvad@redhat.com>
Latest commit 033e35b Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
assemblies doc: renamed doc/guide to doc/manual Mar 13, 2019
meta doc: renamed doc/guide to doc/manual Mar 13, 2019
modules/performance doc: renamed doc/guide to doc/manual Mar 13, 2019
Makefile doc: renamed doc/guide to doc/manual Mar 13, 2019
README.adoc doc: renamed doc/guide to doc/manual Mar 13, 2019
master.adoc

README.adoc

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 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.

You can’t perform that action at this time.