X-Git-Url: https://git.realraum.at/?a=blobdiff_plain;f=doc%2Findex.mdwn;h=5a87d464597a939cbeccda71591bf8dead8727bd;hb=HEAD;hp=ea648ec7ea5a3aada53d90da6a0963c8222910f6;hpb=b9f398a456ca0f3f267138763721647dc8105eaa;p=noc.git diff --git a/doc/index.mdwn b/doc/index.mdwn index ea648ec..5a87d46 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -2,9 +2,15 @@ # Documentation from r³'s NOC -# How to build the documentation +This documentation is meant to: -The documentation can be built locally using the provided - `ikiwiki.setup` settings: +- be public; +- contain a list of all systems the NOC administers, + along with a description of their configuration. + +## How to build the documentation - ikiwiki path/to/source path/to/dest +The documentation can be built locally using the provided + `ikiwiki.setup` settings, simply by calling `make`. By + calling `make serve` a small webserver will be started + on `*:8000` which will serve the wiki directly.