Add Documentation section (incomplete).HEADmaster

3 files changed, 189 insertions, 3 deletions

diff --git a/website/src/docs/index.html b/website/src/docs/index.html
new file mode 100644
index 0000000..ae1f289
--- /dev/null
+++ b/website/src/docs/index.html
@@ -0,0 +1,43 @@
+[% topdir = ".." -%]
+[% PROCESS globals -%]
+[% WRAPPER page
+   title = "virt tools: Documentation"
+   h1 = "virt tools: Documentation"
+   section = "docs"
+   local_stylesheet = 1
+%]
+
+[% FOREACH x IN external_docs_projects %]
+  [% WRAPPER h2 h2="$x" anchor="$x" %]
+  <ul>
+  [% FOREACH y IN external_documents %]
+    [% IF y.project == x %]
+    <li>
+      <a href="[% y.url %]">[% y.name %]</a>
+      [% y.description %]
+      <span class="notes">
+      Difficulty: [% y.difficulty %] out of 5.
+      </span>
+    </li>
+    [% END %]
+  [% END %]
+  </ul>
+  [% END %]
+[% END %]
+
+[% WRAPPER h2 h2="Contribute" anchor="contribute" %]
+
+<p>
+Not found what you're looking for?
+<a href="[% topdir %]/contact/">Contact us via our mailing list
+or chat&nbsp;(IRC).</a>
+</p>
+
+<p>
+Do you know another source for virt tools documentation?
+<a href="[% topdir %]/contact/">Send us a note on the mailing list.</a>
+</p>
+
+[% END %]
+
+[% END -%]
diff --git a/website/src/docs/style.css b/website/src/docs/style.css
new file mode 100644
index 0000000..ecf24d1
--- /dev/null
+++ b/website/src/docs/style.css
@@ -0,0 +1,11 @@
+ul {
+  list-style: none;
+  margin: 0px;
+  padding: 0px;
+}
+
+span.notes {
+  display: block;
+  font-size: 70%;
+  color: #888;
+}
\ No newline at end of file
diff --git a/website/templates/globals b/website/templates/globals
index 891146e..3705398 100644
--- a/website/templates/globals
+++ b/website/templates/globals
@@ -12,16 +12,18 @@ printable_date = date.format
 # These are the sections / tabs of the site as they appear in
 # the navigation at the top of all pages.
 
-sections = [ "home", "learning", "faq", "about", "contact" ]
+sections = [ "home", "learning", "docs", "faq", "about", "contact" ]
 
 section_titles.home = "Home"
 section_titles.learning = "Tutorials and videos"
+section_titles.docs = "Documentation"
 section_titles.faq = "FAQ"
-section_titles.about = "About this site"
-section_titles.contact = "Contact us"
+section_titles.about = "About&nbsp;this&nbsp;site"
+section_titles.contact = "Contact&nbsp;us"
 
 section_paths.home = "/"
 section_paths.learning = "/learning/"
+section_paths.docs = "/docs/"
 section_paths.faq = "/faq/"
 section_paths.about = "/about/"
 section_paths.contact = "/contact/"
@@ -93,5 +95,135 @@ learning_documents = [
             if VMs are running low on space." },
 ]
 
+# External documentation which appears on src/docs/
+# This is for man pages, API documentation, etc which is hosted
+# on upstream project sites.
+#
+# Variables:
+#   project: Name of upstream project (used for categorization).
+#   difficulty: Difficulty level 1 (easy) .. 5 (hardest).
+#   url: Link to the resource.
+#   name: Name of the resource.
+#   description: Longer description of the resource.
+#
+# external_docs_projects is a list of the projects, and projects
+# are displayed in this order on the docs/ page.
+
+external_docs_projects = [ "libvirt", "libguestfs" ]
+
+external_documents = [
+    # Notable libvirt documentation.
+    # XXX Go through libvirt.org site and find more.
+
+    { project = "libvirt", difficulty = 4,
+      url = "http://libvirt.org/html/libvirt-libvirt.html",
+      name = "libvirt API documentation",
+      description = "This is the main documentation for programming
+        against the libvirt API." },
+
+    { project = "libvirt", difficulty = 2,
+      url = "http://libvirt.org/formatdomain.html",
+      name = "libvirt domain XML",
+      description = "This page documents the libvirt XML for
+        domains (guests).  Use <code>virsh edit GuestName</code>
+        to edit this for a particular libvirt guest." },
+
+    # libguestfs man pages
+
+    { project = "libguestfs", difficulty = 4,
+      url = "http://libguestfs.org/guestfs.3.html",
+      name = "libguestfs API documentation",
+      description = "This is the main documentation for programming
+        against the libguestfs API." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/guestfish.1.html",
+      name = "guestfish manual page",
+      description = "Guestfish is an interactive shell tool for viewing
+        and editing disk images, exposing the full libguestfs API.
+        This manual page is the primary reference for all guestfish
+        operations." },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-cat.1.html",
+      name = "virt-cat manual page",
+      description = "virt-cat lets you display a single file from
+        a guest or disk image." },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-df.1.html",
+      name = "virt-df manual page",
+      description = "virt-df lets you display the free disk space in
+        a guest or disk image." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/virt-edit.1.html",
+      name = "virt-edit manual page",
+      description = "virt-edit lets you interactively edit a single
+        file from a guest or disk image, <i>or</i>
+        non-interactively edit from scripts" },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-inspector.1.html",
+      name = "virt-inspector manual page",
+      description = "virt-inspector can inspect an unknown disk image
+        and produce a report on the operating system and applications
+        contained inside it." },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-list-filesystems.1.html",
+      name = "virt-list-filesystems manual page",
+      description = "virt-list-filesystems is primarily a shell
+        script tool for listing out the filesystems found inside
+        a virtual machine or disk image, so you can iterate over them." },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-list-partitions.1.html",
+      name = "virt-list-partitions manual page",
+      description = "virt-list-partitions is like virt-list-filesystems
+        except it lists the partitions found in the disk image." },
+    { project = "libguestfs", difficulty = 2,
+      url = "http://libguestfs.org/virt-ls.1.html",
+      name = "virt-ls manual page",
+      description = "virt-ls is like the <code>ls(1)</code> command
+        for guests and disk images." },
+    { project = "libguestfs", difficulty = 4,
+      url = "http://libguestfs.org/virt-make-fs.1.html",
+      name = "virt-make-fs manual page",
+      description = "virt-make-fs can be used to prepare a disk
+        image containing some predefined content." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/virt-rescue.1.html",
+      name = "virt-rescue manual page",
+      description = "virt-rescue is a <q>rescue shell</q> for virtual
+        machines, similar in concept to the rescue disks used for
+        physical machines." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/virt-resize.1.html",
+      name = "virt-resize manual page",
+      description = "virt-resize lets you expand or shrink guest disk
+        images (offline only).  This complex topic is the subject
+        of this manual page." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/virt-tar.1.html",
+      name = "virt-tar manual page",
+      description = "virt-tar can be used either to extract files and
+        directories from a guest disk image, or to upload files and
+        directories into a disk image." },
+    { project = "libguestfs", difficulty = 3,
+      url = "http://libguestfs.org/virt-win-reg.1.html",
+      name = "virt-win-reg manual page",
+      description = "virt-win-reg is a comprehensive Windows Registry
+        export and merging tool, which you can use to export parts of
+        the Registry from your Windows guests, or to merge changes
+        into your Windows guests." },
+    { project = "libguestfs", difficulty = 5,
+      url = "http://libguestfs.org/guestmount.1.html",
+      name = "guestmount manual page",
+      description = "Guestmount uses libguestfs and FUSE to
+        mount guest filesystems (from disk images) directly
+        on the host." },
+
+    # hivex man pages
+    # XXX
+
+
+
+      
+]
+
 # NB: Make sure you don't add blank lines to the end of this file!
 -%]