From 0eb21ef5d08609287508cf3fb9e967f7fe7c39df Mon Sep 17 00:00:00 2001
From: aszlig <aszlig@redmoonstudios.org>
Date: Fri, 11 Dec 2015 02:15:43 +0100
Subject: doc: Add an introduction to vuizvui.

This should now be on the first page along with the TOC and the
subsequent chapters/parts. All options are in a separate page so that
the user isn't smacked in the face by a list of vuizvui options.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
---
 doc/index.xml   | 34 +++++++++++++++++++++++++++++-----
 doc/options.xml |  9 +++++++++
 2 files changed, 38 insertions(+), 5 deletions(-)
 create mode 100644 doc/options.xml

(limited to 'doc')

diff --git a/doc/index.xml b/doc/index.xml
index bc0e29f7..dd26df3b 100644
--- a/doc/index.xml
+++ b/doc/index.xml
@@ -1,9 +1,33 @@
 <book xmlns="http://docbook.org/ns/docbook"
-    xmlns:xlink="http://www.w3.org/1999/xlink"
-    xmlns:xi="http://www.w3.org/2001/XInclude">
-    <title>Vuizvui-specific NixOS options</title>
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xmlns:xi="http://www.w3.org/2001/XInclude">
+  <title>Vuizvui</title>
+  <preface>
+    <title>What is Vuizvui?</title>
     <para>
-        The following NixOS options are specific to Vuizvui:
+      Vuizvui is a set of NixOS modules and machine configurations that aim to
+      extend <ulink url="https://nixos.org/">NixOS</ulink> in a way that fits
+      the needs of the members of the
+      <ulink url="https://openlab-augsburg.de/">OpenLab Augsburg</ulink>
+      and also serves as a playground for experimental features that are yet to
+      be included in the official NixOS project once they're well tested and
+      matured enough.
     </para>
-    <xi:include href="options-db.xml" />
+
+    <para>
+      This means that module options in Vuizvui are subject to change without
+      retaining backwards-compatibility for configurations outside of the
+      defined machines.
+    </para>
+
+    <para>
+      The name <literal>Vuizvui</literal> is of Bavarian origins and means
+      something like <literal>too much</literal> while on the other side
+      <literal>nix</literal> means nothing. Which fits quite well because this
+      repository is for everything either too complex or not polished/generic
+      enough to be pushed into nixpkgs.
+    </para>
+  </preface>
+
+  <xi:include href="options.xml" />
 </book>
diff --git a/doc/options.xml b/doc/options.xml
new file mode 100644
index 00000000..da30e6c8
--- /dev/null
+++ b/doc/options.xml
@@ -0,0 +1,9 @@
+<part xmlns="http://docbook.org/ns/docbook"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude">
+    <title>Vuizvui-specific NixOS options</title>
+    <para>
+        The following NixOS options are specific to Vuizvui:
+    </para>
+    <xi:include href="options-db.xml" />
+</part>
-- 
cgit 1.4.1