projects
/
noc.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
make kernel command line options configurable.
[noc.git]
/
doc
/
index.mdwn
diff --git
a/doc/index.mdwn
b/doc/index.mdwn
index
ea648ec
..
5a87d46
100644
(file)
--- a/
doc/index.mdwn
+++ b/
doc/index.mdwn
@@
-2,9
+2,15
@@
# Documentation from r³'s NOC
# 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.