Final doc updates

scc · Jan 16, 2001 · 23258da · 23258da
1 parent ed9f1be
commit 23258da
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 31 deletions.
diff --git a/INSTALL b/INSTALL
@@ -29,13 +29,29 @@ SYNOPSIS
     document, because we know you want to get right into the installation.
 
 INSTALLATION
-    Note: For slashd (see utils/slashd, which starts slashd), mod_perl (see
-    httpd/httpd.conf), and MySQL, we set all processes to run in GMT. Then
-    it is easy to convert dates to whatever the user's local time is. If you
-    have date offset problems, check that all of these are properly set to
-    run in GMT.
+  Installation Notes
 
-    Note: All of the installation steps below should be executed as root.
+    *   For slashd (see utils/slashd, which starts slashd), mod_perl (see
+        httpd/httpd.conf), and MySQL, we set all processes to run in GMT.
+        Then it is easy to convert dates to whatever the user's local time
+        is. If you have date offset problems, check that all of these are
+        properly set to run in GMT.
+
+    *   You cannot have different versions of the Slash modules installed
+        for different sites on the same Apache server. Well, if you want to,
+        you can try the Apache::PerlVINC module, but this is not recommended
+        for performance reasons. Slash is designed to have one shared core
+        of code for all Slash sites on a system. (This is made easier than
+        it was in 1.0.x, where to customize a site, you needed to change the
+        module code; this should no longer be necessary.)
+
+    *   All of the installation steps below should be executed as root.
+
+  Installation Procedure
+
+    There are six steps to installation. Skip the parts you already have
+    installed (making sure you have the correct versions). Make sure to read
+    the special note about Apache / mod_perl installation.
 
     1.  Install MySQL.
 
@@ -301,4 +317,4 @@ REQUIREMENTS
     for Slashdot).
 
 VERSION
-    Document last modified Wednesday, January 10, 2001.
+    Document last modified Friday, January 12, 2001.
diff --git a/README b/README
@@ -8,10 +8,11 @@ WARNING
     http://slashcode.com/.
 
 DESCRIPTION
-    Slash is the code that runs Slashdot. More than that, however, Slash is
-    an architecture for putting together web sites. It comes with
-    functionality for posting articles, conducting polls, having
-    discussions, and more. But it can be extended in innumerable ways.
+    Slash -- Slashdot Like Automated Storytelling Homepage -- is the code
+    that runs Slashdot. More than that, however, Slash is an architecture
+    for putting together web sites. It comes with functionality for posting
+    articles, conducting polls, having discussions, and more. But it can be
+    extended in innumerable ways.
 
     Slash is written in Perl, and is built on top of Apache and mod_perl. It
     requires a database backend, though the only well-supported database
@@ -44,6 +45,11 @@ DOCUMENTATION
 
         http://www.template-toolkit.org/
 
+    RSS For more information on RSS 1.0, and the RSS Slash module.
+
+        http://purl.org/rss/1.0/
+        http://www.egroups.com/files/rss-dev/Modules/Proposed/mod_slash.html
+
     Installation
         The details on how to install Slash.
 
@@ -87,7 +93,10 @@ LINKS
         http://sourceforge.net/projects/slashcode/
 
 COPYRIGHT AND LICENSE
-    Slash is copyright (c) 1997-2001, OSDN.
+    The information below applies to everything in this distribution, except
+    where noted.
+
+    Slash is Copyright 1997-2001, Open Source Development Network.
 
             http://www.osdn.com/
 
@@ -99,12 +108,12 @@ COPYRIGHT AND LICENSE
     Slash is distributed in the hope that it will be useful, but WITHOUT ANY
     WARRANTY; without even the implied warranty of MERCHANTABILITY or
     FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-    more details (COPYING).
+    more details.
 
     You should have received a copy of the GNU General Public License along
-    with Slash; if not, go to http://www.fsf.org/ or write to the
+    with Slash (COPYING); if not, go to http://www.fsf.org/ or write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
     02111-1307, USA.
 
 VERSION
-    Document last modified Wednesday, January 10, 2001.
+    Document last modified Friday, January 12, 2001.
diff --git a/docs/INSTALL.html b/docs/INSTALL.html
@@ -14,6 +14,12 @@
 	<LI><A HREF="#NAME">NAME</A>
 	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
 	<LI><A HREF="#INSTALLATION">INSTALLATION</A>
+	<UL>
+
+		<LI><A HREF="#Installation_Notes">Installation Notes</A>
+		<LI><A HREF="#Installation_Procedure">Installation Procedure</A>
+	</UL>
+
 	<LI><A HREF="#INSTALLATION_OPTIONS">INSTALLATION OPTIONS</A>
 	<UL>
 
@@ -100,14 +106,46 @@ <H1><A NAME="SYNOPSIS">SYNOPSIS
 <H1><A NAME="INSTALLATION">INSTALLATION
 
 </A></H1>
-<STRONG>Note</STRONG>: For slashd (see <EM>utils/slashd</EM>, which starts slashd), mod_perl (see <EM>httpd/httpd.conf</EM>), and MySQL, we set all processes to run in GMT. Then it is easy to
+<P>
+<HR>
+<H2><A NAME="Installation_Notes">Installation Notes
+
+</A></H2>
+<UL>
+<LI><STRONG></STRONG>
+For slashd (see <EM>utils/slashd</EM>, which starts slashd), mod_perl (see <EM>httpd/httpd.conf</EM>), and MySQL, we set all processes to run in GMT. Then it is easy to
 convert dates to whatever the user's local time is. If you have date offset
 problems, check that all of these are properly set to run in GMT.
 
 
 <P>
 
-<STRONG>Note</STRONG>: All of the installation steps below should be executed as root.
+<LI><STRONG></STRONG>
+You cannot have different versions of the Slash modules installed for
+different sites on the same Apache server. Well, if you want to, you can
+try the Apache::PerlVINC module, but this is <STRONG>not</STRONG> recommended for performance reasons. Slash is designed to have one shared
+core of code for all Slash sites on a system. (This is made easier than it
+was in 1.0.x, where to customize a site, you needed to change the module
+code; this should no longer be necessary.)
+
+
+<P>
+
+<LI><STRONG></STRONG>
+All of the installation steps below should be executed as root.
+
+
+<P>
+
+</UL>
+<P>
+<HR>
+<H2><A NAME="Installation_Procedure">Installation Procedure
+
+</A></H2>
+There are six steps to installation. Skip the parts you already have
+installed (making sure you have the correct versions). Make sure to read
+the special note about Apache / mod_perl installation.
 
 
 <P>
@@ -676,7 +714,7 @@ <H2><A NAME="Hardware">Hardware
 <H1><A NAME="VERSION">VERSION
 
 </A></H1>
-Document last modified Wednesday, January 10, 2001.
+Document last modified Friday, January 12, 2001.
 
 <P>
 

diff --git a/docs/INSTALL.pod b/docs/INSTALL.pod
@@ -414,4 +414,4 @@ for Slashdot).
 
 =head1 VERSION
 
-Document last modified Wednesday, January 10, 2001.
+Document last modified Friday, January 12, 2001.
diff --git a/docs/README.html b/docs/README.html
@@ -49,10 +49,11 @@ <H1><A NAME="WARNING">WARNING
 <H1><A NAME="DESCRIPTION">DESCRIPTION
 
 </A></H1>
-Slash is the code that runs Slashdot. More than that, however, Slash is an
-architecture for putting together web sites. It comes with functionality
-for posting articles, conducting polls, having discussions, and more. But
-it can be extended in innumerable ways.
+Slash -- Slashdot Like Automated Storytelling Homepage -- is the code that
+runs Slashdot. More than that, however, Slash is an architecture for
+putting together web sites. It comes with functionality for posting
+articles, conducting polls, having discussions, and more. But it can be
+extended in innumerable ways.
 
 
 <P>
@@ -121,6 +122,21 @@ <H1><A NAME="DOCUMENTATION">DOCUMENTATION
 
 
 
+<P>
+
+<DT><STRONG><A NAME="item_RSS">RSS
+
+</A></STRONG><DD>
+For more information on RSS 1.0, and the RSS Slash module.
+
+
+<P>
+
+<A HREF="http://purl.org/rss/1.0/">http://purl.org/rss/1.0/</A> <A
+HREF="http://www.egroups.com/files/rss-dev/Modules/Proposed/mod_slash.html">http://www.egroups.com/files/rss-dev/Modules/Proposed/mod_slash.html</A>
+
+
+
 <P>
 
 <DT><STRONG><A NAME="item_Installation">Installation
@@ -242,7 +258,13 @@ <H1><A NAME="LINKS">LINKS
 <H1><A NAME="COPYRIGHT_AND_LICENSE">COPYRIGHT AND LICENSE
 
 </A></H1>
-Slash is copyright (c) 1997-2001, OSDN.
+The information below applies to everything in this distribution, except
+where noted.
+
+
+<P>
+
+Slash is Copyright 1997-2001, Open Source Development Network.
 
 
 <P>
@@ -263,16 +285,15 @@ <H1><A NAME="COPYRIGHT_AND_LICENSE">COPYRIGHT AND LICENSE
 Slash is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
-details (<EM>COPYING</EM>).
+details.
 
 
 <P>
 
 You should have received a copy of the GNU General Public License along
-with Slash; if not, go to <A
-HREF="http://www.fsf.org/">http://www.fsf.org/</A> or write to the Free
-Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+with Slash (<EM>COPYING</EM>); if not, go to <A HREF="http://www.fsf.org/">http://www.fsf.org/</A> or
+write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.
 
 
 <P>
@@ -282,7 +303,7 @@ <H1><A NAME="COPYRIGHT_AND_LICENSE">COPYRIGHT AND LICENSE
 <H1><A NAME="VERSION">VERSION
 
 </A></H1>
-Document last modified Wednesday, January 10, 2001.
+Document last modified Friday, January 12, 2001.
 
 <P>
 

diff --git a/docs/README.pod b/docs/README.pod
@@ -159,4 +159,4 @@ Suite 330, Boston, MA 02111-1307, USA.
 
 =head1 VERSION
 
-Document last modified Wednesday, January 10, 2001.
+Document last modified Friday, January 12, 2001.