torwachter: rm d3 key as he does no longer want access as told by ruru. Also better...

[noc.git] / doc / index.mdwn

diff --git a/doc/index.mdwn b/doc/index.mdwn
index 4844870..5a87d46 100644 (file)
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -1,3 +1,16 @@
 [[!meta title="Index"]]
 
 # Documentation from r³'s NOC
+
+This documentation is meant to:
+
+- be public;
+- contain a list of all systems the NOC administers,
+  along with a description of their configuration.
+
+## How to build the documentation
+
+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.