doc/index: Fix markdown syntax
[noc.git] / doc / index.mdwn
index 4844870..a683016 100644 (file)
@@ -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:
+
+       ikiwiki path/to/source path/to/dest