Added some "about" documentation to the WebUI and also placed a copy of the current manpage (as built)

in the web directory for easy reference.

3 files changed, 120 insertions, 34 deletions

diff --git a/cobbler/webui/master.py b/cobbler/webui/master.py
index b29bb8c..c33478b 100644
--- a/cobbler/webui/master.py
+++ b/cobbler/webui/master.py
@@ -33,10 +33,10 @@ VFN=valueForName
 currentTime=time.time
 __CHEETAH_version__ = '2.0rc8'
 __CHEETAH_versionTuple__ = (2, 0, 0, 'candidate', 8)
-__CHEETAH_genTime__ = 1190241010.2348001
-__CHEETAH_genTimestamp__ = 'Wed Sep 19 18:30:10 2007'
+__CHEETAH_genTime__ = 1190242431.165633
+__CHEETAH_genTimestamp__ = 'Wed Sep 19 18:53:51 2007'
 __CHEETAH_src__ = 'webui_templates/master.tmpl'
-__CHEETAH_srcLastModified__ = 'Tue Sep 18 15:11:43 2007'
+__CHEETAH_srcLastModified__ = 'Wed Sep 19 18:46:09 2007'
 __CHEETAH_docstring__ = 'Autogenerated by CHEETAH: The Python-Powered Template Engine'
 
 if __CHEETAH_versionTuple__ < RequiredCheetahVersionTuple:
@@ -69,7 +69,7 @@ class master(Template):
 
 
 
-        ## CHEETAH: generated from #block body at line 55, col 1.
+        ## CHEETAH: generated from #block body at line 57, col 1.
         trans = KWS.get("trans")
         if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
             trans = self.transaction # is None unless self.awake() was called
@@ -144,70 +144,72 @@ class master(Template):
 
 <div id="sidebar">
     <ul id="nav">
+        <li><a href="/cobbler/webui/wui.html" class="menu">Docs</a></li>
+        <li><hr/></li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 27, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 27, col 22.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 29, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 29, col 22.
         write('''/settings_view" class="menu">Settings</a></li>
         <li><hr/></li>
         <li>LIST</li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 30, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 30, col 22.
-        write('''/distro_list" class="menu">Distros</a></li>
-        <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 31, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 31, col 22.
-        write('''/profile_list" class="menu">Profiles</a></li>
-        <li><a href="''')
         _v = VFFSL(SL,"base_url",True) # '$base_url' on line 32, col 22
         if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 32, col 22.
-        write('''/system_list" class="menu">Systems</a></li>
+        write('''/distro_list" class="menu">Distros</a></li>
         <li><a href="''')
         _v = VFFSL(SL,"base_url",True) # '$base_url' on line 33, col 22
         if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 33, col 22.
-        write('''/ksfile_list" class="menu">Kickstarts</a></li>
+        write('''/profile_list" class="menu">Profiles</a></li>
         <li><a href="''')
         _v = VFFSL(SL,"base_url",True) # '$base_url' on line 34, col 22
         if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 34, col 22.
+        write('''/system_list" class="menu">Systems</a></li>
+        <li><a href="''')
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 35, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 35, col 22.
+        write('''/ksfile_list" class="menu">Kickstarts</a></li>
+        <li><a href="''')
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 36, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 36, col 22.
         write('''/repo_list" class="menu">Repos</a></li>
         <li><hr/></li>
         <li>ADD</li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 37, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 37, col 22.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 39, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 39, col 22.
         write('''/distro_edit" class="menu">Distro</a></li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 38, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 38, col 22.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 40, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 40, col 22.
         write('''/profile_edit" class="menu">Profile</a></li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 39, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 39, col 22.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 41, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 41, col 22.
         write('''/system_edit" class="menu">System</a></li>
         <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 40, col 22
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 40, col 22.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 42, col 22
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 42, col 22.
         write('''/repo_edit" class="menu">Repo</a></li>
         <li><hr/></li>
 ''')
-        if VFFSL(SL,"logged_in",True) != 'configured': # generated from line 42, col 10
-            if VFFSL(SL,"logged_in",True): # generated from line 43, col 13
+        if VFFSL(SL,"logged_in",True) != 'configured': # generated from line 44, col 10
+            if VFFSL(SL,"logged_in",True): # generated from line 45, col 13
                 write('''                <li><a href="''')
-                _v = VFFSL(SL,"base_url",True) # '$base_url' on line 44, col 30
-                if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 44, col 30.
+                _v = VFFSL(SL,"base_url",True) # '$base_url' on line 46, col 30
+                if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 46, col 30.
                 write('''/logout_submit" class="menu">Log Out</a></li>
 ''')
-            else: # generated from line 45, col 13
+            else: # generated from line 47, col 13
                 write('''                <li><a href="''')
-                _v = VFFSL(SL,"base_url",True) # '$base_url' on line 46, col 30
-                if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 46, col 30.
+                _v = VFFSL(SL,"base_url",True) # '$base_url' on line 48, col 30
+                if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 48, col 30.
                 write('''/login" class="menu">Log In</a></li>
 ''')
             write('''            <li><hr/></li>
 ''')
         write('''       <li><a href="''')
-        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 50, col 21
-        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 50, col 21.
+        _v = VFFSL(SL,"base_url",True) # '$base_url' on line 52, col 21
+        if _v is not None: write(_filter(_v, rawExpr='$base_url')) # from line 52, col 21.
         write('''/sync" class="menu">Sync</A></li>
     </ul>
 </div>
diff --git a/docs/wui.html b/docs/wui.html
index 0a8ec8f..66bfdc4 100644
--- a/docs/wui.html
+++ b/docs/wui.html
@@ -1,2 +1,84 @@
-...
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xml:lang="en" lang="en" xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title>Cobbler Web Interface</title>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
+
+    <link rel="stylesheet" type="text/css" media="all" href="/cobbler/webui/style.css" />
+    <link rel="stylesheet" type="text/css" media="all" href="/cobbler/webui/cobblerweb.css" />
+</head>
+
+<body>
+
+<div id="wrap">
+    <h1 id="masthead">
+        <a href="/cgi-bin/cobbler/webui.cgi/index">
+            <img alt="Cobbler Logo"
+                 src="/cobbler/webui/logo-cobbler.png"/>
+        </a>
+    </h1>
+</div>
+
+<div id="main">
+
+<div id="content">
+
+<h4>Welcome</h4>
+
+<p>
+This is the Web UI for your local <A HREF="http://cobbler.et.redhat.com">Cobbler</A> Server.
+</p>
+
+<p>
+The Cobbler WebUI is designed for day-to-day usage of the Cobbler provisioning server.  It performs
+<i>most</i> but not <i>all</i> of the functions Cobbler can perform.  Nearly all of what you would
+need for routine maintaince of your deployment setups can be done through the web.  If you have
+not already done so, you may be interested to read more about Cobbler at <A HREF="http://cobbler.et.redhat.com">
+cobbler.et.redhat.com</A> and <A HREF="https://hosted.fedoraproject.org/projects/cobbler/">hosted.fedoraproject.org</A>.
+Those pages contain further documentation, tips & tricks, and links to the mailing list and users/developers
+IRC channel.
+</p>
+
+<p>
+It is expected that you have read the <A HREF="<A HREF="/cobbler/webui/cobbler.html">Cobbler manpage</A>, which for the most part focuses on cobbler as run from the command line.  You will need to use the command line some, so please do read the docs.  For starters, you should have started your cobbler install with running "cobbler check" locally.  If not,
+please do so now before continuing.   This will make sure your installation is configured and ready to go.  The rest
+of this document will mainly be detailing the differences between the CLI (as described in the manpage) and the Web interface.
+</p>
+
+<p>
+While you can run the equivalent of "cobbler distro add" commands from the manpage, you can not run
+the very powerful "cobbler import".  So, if you want to start off your boot server using some
+content from a DVD or an rsync mirror -- running cobbler import locally is also a good bet.
+</p>
+
+<p>
+Another command that you cannot run locally is "cobbler reposync", which is a fairly long-running operation
+that you may want to put on a crontab.  You also cannot edit the cobbler settings file (this is more
+of a precaution against locking yourself out of the WebUI), but you can view it.  For instance this means
+that if you want Cobbler to help manage your DHCP config (great!) you can do that through the Web UI
+but you have to turn that on in the settings file.  Furthermore, files like /etc/cobbler/dhcp.template
+have to be edited locally.
+</p>
+
+<p>
+For more information about all that Cobbler can do, please see the <A HREF="/cobbler/webui/cobbler.html">manpage documentation</A>.  Details on setup of this web user interface are also included in the manpage documentation.   For commands like
+"cobbler distro add" and "cobbler distro edit" (etc) the concepts presented in the manpage documentation translate
+to what you see in the Web UI in a one-to-one relationship.  The syntax, values, and meanings of commands and
+variables are all the same. 
+</p>
+
+<br/>
+<br/>
+
+Great.  <A HREF="/cgi-bin/cobbler/webui.cgi">Let's start deploying.</A>
+
+
+</div><!-- content -->
+</div><!-- main -->
+
+</body>
+</html>
+
+
+
 
diff --git a/webui_templates/master.tmpl b/webui_templates/master.tmpl
index 0c3640c..516e994 100644
--- a/webui_templates/master.tmpl
+++ b/webui_templates/master.tmpl
@@ -24,6 +24,8 @@
 
 <div id="sidebar">
     <ul id="nav">
+        <li><a href="/cobbler/webui/wui.html" class="menu">Docs</a></li>
+        <li><hr/></li>
         <li><a href="$base_url/settings_view" class="menu">Settings</a></li>
         <li><hr/></li>
         <li>LIST</li>