• Leigh Stoller's avatar
    The Emulab Knowledge Base! · 6f08c442
    Leigh Stoller authored
    Okay, I implemented a primitive Knowledge Base! The current contents are
    *all* the existing FAQ entries, which I entered manually. Here are the
    details.
    
    * My reason for doing this is that we need something very simple. The wiki
      is too much of a barrier, and its search capabilities are pathetic.
    
    * The search page for the Knowledge Base is:
    
    	https://www.emulab.net/kb-search.php3
    
      Fairly primitive keyword search. Turns out that mysql 4.0 has a bunch for
      really good text searching functions built in, but we run 3.23 ... so I
      had to roll it myself. So, its a simple keyword (space or comma
      separated) search, no regular expressions.
    
    * Each DB record has a "faq_entry" flag, so creating the current FAQ on the
      fly from the DB is easy. See:
    
    	https://www.emulab.net/kb-faq.php3
    
    * In reddot mode, you can add new KB entries:
    
    	https://www.emulab.net/kb-manage.php3
    
      The form is fairly obvious but here are details anyway:
    
        Section Name: Choose an existing title, or make up a new one.
        Title:        The title of the KB (or FAQ) entry.
        Faq Entry:    Check this box if the new entry should show up in the FAQ.
        X Ref Tag:    A token so you can refer to other KB entries by name,
                      instead of by its index. Within the KB entry you would
                      write: <a href=kb-show.php3?xref_tag=sometag>
        Body:         Whatever you like. I took the existing FAQ entries and
                      stuck them with no changes except for the xref_tag
                      mentioned about (since some entries referenced other
                      entries).
    
    * Once you click on sumbit, you will see the entry as it will appear to
      users, along with a submenu to Modify/Delete/Add entries. You can modify
      the current entry from that menu. Mere users do not see this menu, only
      when in reddot mode.
    
    * The intent here is that we can generate new entries really easy, right
      from email if you like (with appropriate <pre> or <xmp> tags around it).
    
    * I have added sql/knowlbase-create.sql and a makefile target to
      generate that file when creating a distribution. I also added a section
      to install/boss-install to insert the entries into the new DB.
    
    * I hooked the search function into the existing Search Documentation link.
      We know search both the Knowledge Base *and* the Documentation on doc
      searches. This probably needs a little more work to get right.
    
    * I changed a lot of faq links to be more consistent and to reference
      the proper xref_tags (#swapping instead of #UTT-34).
    6f08c442
Name
Last commit
Last update
account Loading commit data...
apache Loading commit data...
assign Loading commit data...
autoconf Loading commit data...
bugdb Loading commit data...
capture Loading commit data...
cdrom Loading commit data...
collab Loading commit data...
daikon Loading commit data...
db Loading commit data...
delay/linux Loading commit data...
dhcpd Loading commit data...
discvr Loading commit data...
doc Loading commit data...
event Loading commit data...
firewall Loading commit data...
hw_config Loading commit data...
hyperviewer Loading commit data...
install Loading commit data...
ipod Loading commit data...
lib Loading commit data...
mote Loading commit data...
named Loading commit data...
os Loading commit data...
patches Loading commit data...
pxe Loading commit data...
rc.d Loading commit data...
robots Loading commit data...
rpms Loading commit data...
security Loading commit data...
sensors Loading commit data...
sql Loading commit data...
ssl Loading commit data...
sysadmin Loading commit data...
tbsetup Loading commit data...
testsuite Loading commit data...
tip Loading commit data...
tmcd Loading commit data...
tools Loading commit data...
utils Loading commit data...
vis Loading commit data...
wiki Loading commit data...
www Loading commit data...
xmlrpc Loading commit data...
.loc-ignore Loading commit data...
BUGS Loading commit data...
GNUmakefile.in Loading commit data...
GNUmakerules Loading commit data...
GPL-COPYING Loading commit data...
LGPL-COPYING Loading commit data...
LICENSE Loading commit data...
Makeconf.in Loading commit data...
README Loading commit data...
TODO Loading commit data...
TODO.plab Loading commit data...
config.h.in Loading commit data...
configure Loading commit data...
configure.in Loading commit data...
defs-aerolab Loading commit data...
defs-calfeld-emulab Loading commit data...
defs-davidand-emulab Loading commit data...
defs-default Loading commit data...
defs-duerig-emulab Loading commit data...
defs-elabinelab Loading commit data...
defs-example Loading commit data...
defs-fish-emulab Loading commit data...
defs-gatech Loading commit data...
defs-johnsond-emulab Loading commit data...
defs-kwebb-emulab Loading commit data...
defs-newbold-emulab Loading commit data...
defs-newbold-macdb Loading commit data...
defs-ricci-emulab Loading commit data...
defs-shash-emulab Loading commit data...
defs-stoller-emulab Loading commit data...
defs-stoller-home Loading commit data...
defs-stoller-lbsdb Loading commit data...
defs-uky Loading commit data...
defs-wide Loading commit data...