Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Oops, doc upgrade

  • Loading branch information...
commit 08084fc3cf6d12edfaa2dd661e6682ffbb0c34c4 1 parent cd49f30
Chris Nandor authored
238  INSTALL
@@ -2,9 +2,10 @@ NAME
2 2
     INSTALL - Slash Installation
3 3
 
4 4
 SYNOPSIS
5  
-    This document describes how to install Slash 2.1/2.2. For instructions
6  
-    on installation of previous versions of Slash, see the INSTALL document
7  
-    included with those distributions.
  5
+    This document describes how to install Slash 2.1/2.2 (where you see
  6
+    "2.2" you may safely assume "2.1", except where specified). For
  7
+    instructions on installation or upgrade of previous versions of Slash,
  8
+    see the INSTALL document included with those distributions.
8 9
 
9 10
     These instructions have only been tested on Linux. Installation under
10 11
     BSD and other Unix OSes should work similarly, but there are problems
@@ -19,7 +20,7 @@ SYNOPSIS
19 20
     Slash can always be downloaded from SourceForge, from the FTP site, and
20 21
     via CVS.
21 22
 
22  
-            http://sourceforge.net/projects/slashcode/
  23
+            http://sf.net/projects/slashcode/
23 24
             ftp://ftp.slashcode.com//pub/slashcode/
24 25
             http://cvs.slashcode.com/
25 26
 
@@ -34,34 +35,6 @@ SYNOPSIS
34 35
 
35 36
     Upgrading information is also toward the end of the document.
36 37
 
37  
-VERSIONS
38  
-    Each version of slash has a code name, and the files on CVS for that
39  
-    version are tagged with that name. The current release is always MAIN.
40  
-    The versioning scheme is as Linux and Perl are,
41  
-    revision.version.subversion. version is even for releases, and odd for
42  
-    development. The codename applies to the development version and
43  
-    subsequent release.
44  
-
45  
-    For example, 1.0.11 is a normal release, while 1.1.0 is the first
46  
-    development release for what will be the next release (either 1.2 or
47  
-    2.0).
48  
-
49  
-    The CVS repository is tagged with version numbers, so to get release
50  
-    1.0.3, use tag "v1_0_3_0". The last number (in this case a zero) will be
51  
-    incremented during development ("v1_0_3_1", "v1_0_3_2", etc.) until the
52  
-    next release.
53  
-
54  
-  Codenames
55  
-
56  
-    v1.0
57  
-        beast
58  
-
59  
-    v2.0
60  
-        bender
61  
-
62  
-    v2.2
63  
-        fry
64  
-
65 38
 INSTALLATION
66 39
   Installation Notes
67 40
 
@@ -109,7 +82,8 @@ INSTALLATION
109 82
     2.  Install perl.
110 83
 
111 84
         perl is likely already installed on your machine; make sure its
112  
-        version is 5.005_03 or better.
  85
+        version is at least the minimum required (see the section on
  86
+        "REQUIREMENTS").
113 87
 
114 88
     3.  Install Apache and mod_perl.
115 89
 
@@ -153,9 +127,9 @@ INSTALLATION
153 127
             With some versions of the CPAN module, the module will try to
154 128
             download and install the latest version of Perl. Watch what the
155 129
             module is doing; if it begins to download an entire perl
156  
-            distribution, hit ctrl-C until it stops, then try again with the
157  
-            CPAN module. This should not be an issue in the latest version
158  
-            of Bundle::Slash.
  130
+            distribution, interrupt it (hit ctrl-C) until it stops, then try
  131
+            again with the CPAN module. This should not be an issue in the
  132
+            latest version of Bundle::Slash.
159 133
 
160 134
         Uninstalling Old Modules
161 135
             Sometimes, you will be installing a newer version of a module
@@ -173,8 +147,8 @@ INSTALLATION
173 147
 
174 148
         Additional Libraries
175 149
             You must have certain libraries existing on your system before
176  
-            building, for Compress::Zlib and XML::Parser. See the section on
177  
-            "perl".
  150
+            building, for Compress::Zlib and XML::Parser (see the section on
  151
+            "REQUIREMENTS").
178 152
 
179 153
         BSD
180 154
             If running BSD, also install the BSD::Resource module.
@@ -197,7 +171,7 @@ INSTALLATION
197 171
             libnet is currently broken somewhat in its tests. Please use
198 172
             "install Net::Cmd" first, before you install anything else. If
199 173
             it fails only tests 8 and 9 of t/require, then it is OK; just do
200  
-            <force install Net::Cmd>, then continue on with the rest of the
  174
+            "force install Net::Cmd", then continue on with the rest of the
201 175
             modules installation.
202 176
 
203 177
         To use the CPAN module, invoke the CPAN shell:
@@ -226,8 +200,8 @@ INSTALLATION
226 200
                 make
227 201
                 make install
228 202
 
229  
-        Note: you will want the GNU versions of fileutils (version
230  
-        4.0 recommended, for cp and install) and make.  Older versions of
  203
+        Note: you will want the GNU versions of fileutils (version 4.0
  204
+        recommended, for cp and install) and make. Older versions of
231 205
         install, and make and cp from other systems, might not work.
232 206
 
233 207
         There are a few options to "make" and "make install" you may want to
@@ -241,10 +215,10 @@ INSTALLATION
241 215
                                                         scripts
242 216
                 USER            nobody                  User to own files
243 217
                 GROUP           nobody                  Group to own files
244  
-                CP		cp			Name of or path to
245  
-                					alternate `cp`
246  
-                INSTALL		install			Name of or path to
247  
-                					alternate `install`
  218
+                CP              cp                      Name of or path to
  219
+                                                        alternate `cp`
  220
+                INSTALL         install                 Name of or path to
  221
+                                                        alternate `install`
248 222
 
249 223
         (USER and GROUP will also be changed later on a per-site basis, in
250 224
         step 6. while running install-slashsite.)
@@ -358,11 +332,105 @@ INSTALLATION OPTIONS
358 332
     system.
359 333
 
360 334
 UPGRADING
361  
-  Slash 2.0 -> Slash 2.1/2.2
  335
+    These upgrade procedures are still in testing. Please read them entirely
  336
+    before beginning. We are not responsible for any loss of data or
  337
+    functionality.
  338
+
  339
+  Slash 2.0 -> Slash 2.2
  340
+
  341
+    1.  BACK EVERYTHING UP ON THE EXISTING SITE.
  342
+
  343
+    2.  Install Bundle::Slash. If you have done so previously, follow the
  344
+        instructions for removing the existing version of Bundle::Slash
  345
+        before proceeding.
  346
+
  347
+    3.  Apply this patch to your installed Slash::Install module (probably
  348
+        easiest to hand-edit the file):
  349
+
  350
+          --- Install.pm~ Wed May  9 15:02:34 2001
  351
+          +++ Install.pm  Fri Sep 28 12:44:41 2001
  352
+          @@ -116,7 +116,7 @@
  353
+           sub writeTemplateFile {
  354
+                  my($self, $filename, $template) = @_;
  355
+                  open(FILE, '>' . $filename) or die "$! unable to open file $filename to write to";
  356
+          -       for (keys %$template) {
  357
+          +       for (qw(section description title page lang name template seclev)) {
  358
+                          next if ($_ eq 'tpid');
  359
+                          print FILE "__${_}__\n";
  360
+                          $template->{$_} =~ s/\015\012/\n/g;
  361
+
  362
+    4.  Run "template-check" on your site, and make a note of every change
  363
+        you've made to the standard templates. You will need to make those
  364
+        changes again, manually, later.
  365
+
  366
+        This is unfortunately unavoidable, because templates include code
  367
+        that changes significantly between releases. It is recommended that
  368
+        you compile your changes into a THEME so they may easily be updated
  369
+        and applied.
  370
+
  371
+    5.  Stop Apache and slashd on the target machine(s).
  372
+
  373
+    6   Install Slash.
  374
+
  375
+        If installing on a different machine ...
  376
+
  377
+        1   Install slash 2.2 as normal. Do not yet run install-slashsite.
  378
+
  379
+        2   Make sure that from this machine, you can access not only the
  380
+            database used for this installation, but the one used for the
  381
+            old installation. You may wish to, instead of accessing that
  382
+            database directly if it on another machine, dumping it and
  383
+            adding it to your new database server under a different name.
  384
+
  385
+        3   Add a virtual user to DBIx::Password for the old installation.
  386
+
  387
+        If installing on the same machine ...
  388
+
  389
+        1   Create a new database for the new installation. You cannot use
  390
+            the same database for both installations.
  391
+
  392
+        2   Add a new virtual user to DBIx::Password for the new database,
  393
+            and update (and flush) MySQL privileges appropriately. You
  394
+            cannot use the same virtual user for both installations.
362 395
 
363  
-    These procedures do not yet exist. See the README manpage.
  396
+        3   It is highly recommended that you move /usr/local/slash (or
  397
+            whatever your installation directory is) to a new location, such
  398
+            as /usr/local/slash-old, and install a clean slash 2.2
  399
+            installation. However, this is not necessary to do; you may
  400
+            install slash 2.2 on top of the slash 2.0 installation.
364 401
 
365  
-  Slash 2.0.x -> Slash 2.0.y
  402
+            The reason to not move anything is that you can keep any
  403
+            customizations done (images, additional scripts and plugins,
  404
+            static files, etc.). The reason to move it is so that everything
  405
+            is clean. It is highly recommended that you move it, and then
  406
+            manually copy back the pieces you want.
  407
+
  408
+        4   In any event, either move the old directory, or don't, and then
  409
+            install slash 2.2 as normal. Do not yet run install-slashsite.
  410
+
  411
+    7.  If you have plugins or themes from the old installation to install,
  412
+        copy them over now. Warning: some plugins and themes might need to
  413
+        be ported first. You may wish to deal with them later if they are
  414
+        not yet ported to slash 2.2.
  415
+
  416
+    8.  Run install-slashsite. Use the new virtual user.
  417
+
  418
+    9.  Copy over any files (images, FAQs, etc.) that need to be copied, if
  419
+        necessary.
  420
+
  421
+    10. Run update script, utils/slash2toslash2.2. Read its instructions!
  422
+
  423
+    11. Update templates.
  424
+
  425
+    12. Doublecheck Apache configs (httpd/slash.conf,
  426
+        site/sitename/sitename.conf). These configs have changed from the
  427
+        last version. Read the comments and set them up as desired.
  428
+
  429
+    13. Start Apache.
  430
+
  431
+    14. Start slashd.
  432
+
  433
+  Slash 2.2.x -> Slash 2.2.y
366 434
 
367 435
     Read all of this section before doing any of it.
368 436
 
@@ -433,47 +501,11 @@ UPGRADING
433 501
 
434 502
                     % template-tool -u VIRTUAL_USER -s LIST
435 503
 
436  
-    Data
437  
-        Currently, there are no differences in the schema between versions
438  
-        of Slash 2.0. There are a few data differences.
439  
-
440  
-        Slash 2.0.0-pre1 -> Slash-2.0.0 release
441  
-            Journal Data
442  
-                In the vars table, "journal_default_display" is set to "0".
443  
-                It should default to "10".
  504
+  Slash 1.0 -> Slash 2.2
444 505
 
445  
-                Also, "journal_user_count" is no longer in use and may be
446  
-                deleted.
447  
-
448  
-                See plugins/Journal/dump.
449  
-
450  
-            Search Data
451  
-                "search_default_display" should be defined in the vars
452  
-                table, with a default of "30".
453  
-
454  
-                See plugins/Search/dump.
455  
-
456  
-    Templates
457  
-        Listed below are additions/deletions of templates from version to
458  
-        version. Feel free to delete (or not) ones that are no longer used,
459  
-        but please do add to your site templates that have been added to the
460  
-        distribution. Add or delete, for your site, all the changes from
461  
-        your current version up through the version you're upgrading to.
462  
-
463  
-        Slash 2.0.0-pre2 -> Slash 2.0.0
464  
-            Added
465  
-                plugins/Journal/templates/pagination;journal;default
466  
-                plugins/Search/templates/pagination;search;default
467  
-                themes/slashcode/templates/dispLinkComment;misc;default
468  
-            Deleted
469  
-                plugins/Journal/templates/journalitem;journal;default
470  
-                plugins/Search/templates/linksearch;search;default
471  
-
472  
-  Slash 1.0 -> Slash 2.0
473  
-
474  
-    Please read the complete documentation of utils/slash1toslash2. It is a
475  
-    program that will convert your database from Slash 1.0 to a new Slash
476  
-    2.0 database. The program documentation (which can be read with perldoc)
  506
+    Please read the complete documentation of utils/slash1toslash2.2. It is
  507
+    a program that will convert your database from Slash 1.0 to a new Slash
  508
+    2.2 database. The program documentation (which can be read with perldoc)
477 509
     details exactly what process it follows to do the conversion, so you can
478 510
     attempt to do it by hand if you prefer.
479 511
 
@@ -522,7 +554,7 @@ REQUIREMENTS
522 554
         the modules.
523 555
 
524 556
                 http://www.gzip.org/zlib/
525  
-                http://sourceforge.net/projects/expat/
  557
+                http://sf.net/projects/expat/
526 558
 
527 559
         The following required distributions are all included in the
528 560
         Bundle::Slash distribution.
@@ -585,6 +617,34 @@ REQUIREMENTS
585 617
     everything (we use a minimum of two web server machines on every site
586 618
     for load balancing and redundancy).
587 619
 
  620
+VERSIONS
  621
+    Each version of slash has a code name, and the files on CVS for that
  622
+    version are tagged with that name. The current release is always MAIN.
  623
+    The versioning scheme is as Linux and Perl are,
  624
+    revision.version.subversion. version is even for releases, and odd for
  625
+    development. The codename applies to the development version and
  626
+    subsequent release.
  627
+
  628
+    For example, 1.0.11 is a normal release, while 1.1.0 is the first
  629
+    development release for what will be the next release (either 1.2 or
  630
+    2.0).
  631
+
  632
+    The CVS repository is tagged with version numbers, so to get release
  633
+    1.0.3, use tag "v1_0_3_0". The last number (in this case a zero) will be
  634
+    incremented during development ("v1_0_3_1", "v1_0_3_2", etc.) until the
  635
+    next release.
  636
+
  637
+  Codenames
  638
+
  639
+    v1.0
  640
+        beast
  641
+
  642
+    v2.0
  643
+        bender
  644
+
  645
+    v2.2
  646
+        fry
  647
+
588 648
 VERSION
589 649
     $Id$
590 650
 
25  README
@@ -6,8 +6,9 @@ WARNING
6 6
     production use, and is constantly changing. Please use this only for
7 7
     development and testing purposes.
8 8
 
9  
-    There are currently NO upgrade procedures in place for previous versions
10  
-    of Slash. Those will be coming in a subsequent beta.
  9
+    The upgrade procedures are available (the INSTALL manpage). Standard
  10
+    disclaimer applies. Please test them if you are so inclined, and let us
  11
+    know how they work for you.
11 12
 
12 13
 DESCRIPTION
13 14
     Slash -- Slashdot Like Automated Storytelling Homepage -- is the code
@@ -37,7 +38,7 @@ DESCRIPTION
37 38
     As noted in the FAQ, please send any bug reports, and subscribe to
38 39
     mailing lists, at Slash's SourceForge site.
39 40
 
40  
-            http://sourceforge.net/projects/slashcode/
  41
+            http://sf.net/projects/slashcode/
41 42
 
42 43
 DOCUMENTATION
43 44
     The .pod documentation included with Slash can be read with the
@@ -94,16 +95,20 @@ DOCUMENTATION
94 95
     Schema
95 96
         The layout and description of the database. [These are out of date.]
96 97
 
97  
-        docs/slasherd_bender.fig
  98
+        docs/slasherd.fig
98 99
 
99  
-        docs/slasherd_bender.pdf
  100
+        docs/slasherd.ps
100 101
 
101  
-        docs/slasherd_bender.ps
102  
-
103  
-        docs/slashtables_bender.pod
  102
+        docs/slashtables.pod
104 103
 
105 104
     Other
106  
-        We need to upgrade the Getting Started document.
  105
+        The slashguide document (previously called getting_started) helps
  106
+        you get your feet wet and gives vital information for how to run a
  107
+        Slash site.
  108
+
  109
+        docs/slashguide.pod
  110
+
  111
+        themes/slashcode/htdocs/slashguide.shtml
107 112
 
108 113
     Authors
109 114
         The authors and contributors of Slash.
@@ -129,7 +134,7 @@ LINKS
129 134
     SourceForge Site
130 135
         Access to the code, bug reports, patches, mailing lists, and more.
131 136
 
132  
-        http://sourceforge.net/projects/slashcode/
  137
+        http://sf.net/projects/slashcode/
133 138
 
134 139
 COPYRIGHT AND LICENSE
135 140
     The information below applies to everything in this distribution, except
290  docs/INSTALL.html
@@ -18,12 +18,6 @@
18 18
 		<LI><A HREF="#important_note">Important Note</A></LI>
19 19
 	</UL></LI>
20 20
 
21  
-	<LI><A HREF="#versions">VERSIONS</A>
22  
-	<UL>
23  
-
24  
-		<LI><A HREF="#codenames">Codenames</A></LI>
25  
-	</UL></LI>
26  
-
27 21
 	<LI><A HREF="#installation">INSTALLATION</A>
28 22
 	<UL>
29 23
 
@@ -43,9 +37,9 @@
43 37
 	<LI><A HREF="#upgrading">UPGRADING</A>
44 38
 	<UL>
45 39
 
46  
-		<LI><A HREF="#slash_2.0___slash_2.1_2.2">Slash 2.0 -&gt; Slash 2.1/2.2</A></LI>
47  
-		<LI><A HREF="#slash_2.0.x___slash_2.0.y">Slash 2.0.x -&gt; Slash 2.0.y</A></LI>
48  
-		<LI><A HREF="#slash_1.0___slash_2.0">Slash 1.0 -&gt; Slash 2.0</A></LI>
  40
+		<LI><A HREF="#slash_2.0___slash_2.2">Slash 2.0 -&gt; Slash 2.2</A></LI>
  41
+		<LI><A HREF="#slash_2.2.x___slash_2.2.y">Slash 2.2.x -&gt; Slash 2.2.y</A></LI>
  42
+		<LI><A HREF="#slash_1.0___slash_2.2">Slash 1.0 -&gt; Slash 2.2</A></LI>
49 43
 	</UL></LI>
50 44
 
51 45
 	<LI><A HREF="#requirements">REQUIREMENTS</A>
@@ -55,6 +49,12 @@
55 49
 		<LI><A HREF="#hardware">Hardware</A></LI>
56 50
 	</UL></LI>
57 51
 
  52
+	<LI><A HREF="#versions">VERSIONS</A>
  53
+	<UL>
  54
+
  55
+		<LI><A HREF="#codenames">Codenames</A></LI>
  56
+	</UL></LI>
  57
+
58 58
 	<LI><A HREF="#version">VERSION</A></LI>
59 59
 </UL>
60 60
 <!-- INDEX END -->
@@ -66,9 +66,10 @@
66 66
 <P>
67 67
 <HR>
68 68
 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
69  
-<P>This document describes how to install Slash 2.1/2.2.  For instructions on
70  
-installation of previous versions of Slash, see the INSTALL document
71  
-included with those distributions.</P>
  69
+<P>This document describes how to install Slash 2.1/2.2 (where you see
  70
+"2.2" you may safely assume "2.1", except where specified).  For instructions on
  71
+installation or upgrade of previous versions of Slash, see the INSTALL
  72
+document included with those distributions.</P>
72 73
 <P>These instructions have only been tested on Linux. Installation under
73 74
 BSD and other Unix OSes should work similarly, but there are problems
74 75
 with the Makefile and installtion under some non-Linux OSes.  Feel free
@@ -80,7 +81,7 @@
80 81
 <P>Slash can always be downloaded from SourceForge, from the FTP site,
81 82
 and via CVS.</P>
82 83
 <PRE>
83  
-        <A HREF="http://sourceforge.net/projects/slashcode/">http://sourceforge.net/projects/slashcode/</A>
  84
+        <A HREF="http://sf.net/projects/slashcode/">http://sf.net/projects/slashcode/</A>
84 85
         <A HREF="ftp://ftp.slashcode.com//pub/slashcode/">ftp://ftp.slashcode.com//pub/slashcode/</A>
85 86
         <A HREF="http://cvs.slashcode.com/">http://cvs.slashcode.com/</A></PRE>
86 87
 <P>See the SourceForge page for patches and bug reports.</P>
@@ -93,37 +94,6 @@
93 94
 <P>Upgrading information is also toward the end of the document.</P>
94 95
 <P>
95 96
 <HR>
96  
-<H1><A NAME="versions">VERSIONS</A></H1>
97  
-<P>Each version of slash has a code name, and the files on CVS for that
98  
-version are tagged with that name.  The current release is always
99  
-MAIN.  The versioning scheme is as Linux and Perl are,
100  
-revision.version.subversion.  version is even for releases, and odd
101  
-for development.  The codename applies to the development version
102  
-and subsequent release.</P>
103  
-<P>For example, 1.0.11 is a normal release, while 1.1.0 is the first
104  
-development release for what will be the next release (either 1.2
105  
-or 2.0).</P>
106  
-<P>The CVS repository is tagged with version numbers, so to get release
107  
-1.0.3, use tag "v1_0_3_0".  The last number (in this case a zero) will
108  
-be incremented during development ("v1_0_3_1", "v1_0_3_2", etc.) until
109  
-the next release.</P>
110  
-<P>
111  
-<H2><A NAME="codenames">Codenames</A></H2>
112  
-<DL>
113  
-<DT><STRONG><A NAME="item_v1%2E0">v1.0</A></STRONG><BR>
114  
-<DD>
115  
-beast
116  
-<P></P>
117  
-<DT><STRONG><A NAME="item_v2%2E0">v2.0</A></STRONG><BR>
118  
-<DD>
119  
-bender
120  
-<P></P>
121  
-<DT><STRONG><A NAME="item_v2%2E2">v2.2</A></STRONG><BR>
122  
-<DD>
123  
-fry
124  
-<P></P></DL>
125  
-<P>
126  
-<HR>
127 97
 <H1><A NAME="installation">INSTALLATION</A></H1>
128 98
 <P>
129 99
 <H2><A NAME="installation_notes">Installation Notes</A></H2>
@@ -172,7 +142,7 @@
172 142
 <LI>
173 143
 <STRONG>Install perl.</STRONG>
174 144
 <P>perl is likely already installed on your machine; make sure its
175  
-version is 5.005_03 or better.</P>
  145
+version is at least the minimum required (see <A HREF="#requirements">REQUIREMENTS</A>).</P>
176 146
 <P></P>
177 147
 <LI>
178 148
 <STRONG>Install Apache and mod_perl.</STRONG>
@@ -212,9 +182,9 @@
212 182
 With some versions of the CPAN module, the module will try to
213 183
 download and install the latest version of Perl.  Watch what
214 184
 the module is doing; if it begins to download an entire perl
215  
-distribution, hit ctrl-C until it stops, then try again with the
216  
-CPAN module.  This should not be an issue in the latest version
217  
-of Bundle::Slash.
  185
+distribution, interrupt it (hit ctrl-C) until it stops, then try
  186
+again with the CPAN module.  This should not be an issue in the latest
  187
+version of Bundle::Slash.
218 188
 <P></P>
219 189
 <DT><STRONG><A NAME="item_Uninstalling_Old_Modules"><STRONG>Uninstalling Old Modules</STRONG></A></STRONG><BR>
220 190
 <DD>
@@ -235,7 +205,7 @@
235 205
 <DT><STRONG><A NAME="item_Additional_Libraries"><STRONG>Additional Libraries</STRONG></A></STRONG><BR>
236 206
 <DD>
237 207
 You must have certain libraries existing on your system before
238  
-building, for Compress::Zlib and XML::Parser.  See <A HREF="#perl">perl</A>.
  208
+building, for Compress::Zlib and XML::Parser (see <A HREF="#requirements">REQUIREMENTS</A>).
239 209
 <P></P>
240 210
 <DT><STRONG><A NAME="item_BSD"><STRONG>BSD</STRONG></A></STRONG><BR>
241 211
 <DD>
@@ -262,7 +232,7 @@
262 232
 libnet is currently broken somewhat in its tests.  Please use
263 233
 <CODE>install Net::Cmd</CODE> first, before you install anything else.
264 234
 If it fails only tests 8 and 9 of t/require, then it is OK;
265  
-just do &lt;force install Net::Cmd&gt;, then continue on with the
  235
+just do <CODE>force install Net::Cmd</CODE>, then continue on with the
266 236
 rest of the modules installation.
267 237
 <P></P></DL>
268 238
 <P>To use the CPAN module, invoke the CPAN shell:</P>
@@ -299,10 +269,10 @@
299 269
                                                 scripts
300 270
         USER            nobody                  User to own files
301 271
         GROUP           nobody                  Group to own files
302  
-	CP		cp			Name of or path to
303  
-						alternate `cp`
304  
-	INSTALL		install			Name of or path to
305  
-						alternate `install`</PRE>
  272
+        CP              cp                      Name of or path to
  273
+                                                alternate `cp`
  274
+        INSTALL         install                 Name of or path to
  275
+                                                alternate `install`</PRE>
306 276
 <P>(USER and GROUP will also be changed later on a per-site basis,
307 277
 in step 6. while running <EM>install-slashsite</EM>.)</P>
308 278
 <P>So, for example, you might type (although the default SLASH_PREFIX
@@ -407,11 +377,123 @@
407 377
 <P>
408 378
 <HR>
409 379
 <H1><A NAME="upgrading">UPGRADING</A></H1>
  380
+<P><STRONG>These upgrade procedures are still in testing.  Please read them
  381
+entirely before beginning.  We are not responsible for any loss of
  382
+data or functionality.</STRONG></P>
410 383
 <P>
411  
-<H2><A NAME="slash_2.0___slash_2.1_2.2">Slash 2.0 -&gt; Slash 2.1/2.2</A></H2>
412  
-<P>These procedures do not yet exist.  See <EM>README</EM>.</P>
  384
+<H2><A NAME="slash_2.0___slash_2.2">Slash 2.0 -&gt; Slash 2.2</A></H2>
  385
+<OL>
  386
+<LI>
  387
+BACK EVERYTHING UP ON THE EXISTING SITE.
  388
+<P></P>
  389
+<LI>
  390
+Install Bundle::Slash.  If you have done so previously, follow
  391
+the instructions for removing the existing version of
  392
+Bundle::Slash before proceeding.
  393
+<P></P>
  394
+<LI>
  395
+Apply this patch to your installed Slash::Install module (probably
  396
+easiest to hand-edit the file):
  397
+<PRE>
  398
+  --- Install.pm~ Wed May  9 15:02:34 2001
  399
+  +++ Install.pm  Fri Sep 28 12:44:41 2001
  400
+  @@ -116,7 +116,7 @@
  401
+   sub writeTemplateFile {
  402
+          my($self, $filename, $template) = @_;
  403
+          open(FILE, '&gt;' . $filename) or die &quot;$! unable to open file $filename to write to&quot;;
  404
+  -       for (keys %$template) {
  405
+  +       for (qw(section description title page lang name template seclev)) {
  406
+                  next if ($_ eq 'tpid');
  407
+                  print FILE &quot;__${_}__\n&quot;;
  408
+                  $template-&gt;{$_} =~ s/\015\012/\n/g;</PRE>
  409
+<P></P>
  410
+<LI>
  411
+Run <CODE>template-check</CODE> on your site, and make a note of every change
  412
+you've made to the standard templates.  You will need to make those
  413
+changes again, manually, later.
  414
+<P>This is unfortunately unavoidable, because templates include code
  415
+that changes significantly between releases.  It is recommended
  416
+that you compile your changes into a THEME so they may easily be
  417
+updated and applied.</P>
  418
+<P></P>
  419
+<LI>
  420
+Stop Apache and slashd on the target machine(s).
  421
+<P></P>
  422
+<LI>
  423
+Install Slash.
  424
+<P><STRONG>If installing on a different machine ...</STRONG></P>
  425
+<OL>
  426
+<LI>
  427
+Install slash 2.2 as normal.  Do not yet run install-slashsite.
  428
+<P></P>
  429
+<LI>
  430
+Make sure that from this machine, you can access not only the database
  431
+used for this installation, but the one used for the old installation.
  432
+You may wish to, instead of accessing that database directly if it
  433
+on another machine, dumping it and adding it to your new database server
  434
+under a different name.
  435
+<P></P>
  436
+<LI>
  437
+Add a virtual user to DBIx::Password for the old installation.
  438
+<P></P></OL>
  439
+<P><STRONG>If installing on the same machine ...</STRONG></P>
  440
+<OL>
  441
+<LI>
  442
+Create a new database for the new installation.  You cannot
  443
+use the same database for both installations.
  444
+<P></P>
  445
+<LI>
  446
+Add a new virtual user to DBIx::Password for the new database,
  447
+and update (and flush) MySQL privileges appropriately.  You cannot
  448
+use the same virtual user for both installations.
  449
+<P></P>
  450
+<LI>
  451
+It is highly recommended that you move <EM>/usr/local/slash</EM>
  452
+(or whatever your installation directory is) to a new location,
  453
+such as <EM>/usr/local/slash-old</EM>, and install a clean slash 2.2
  454
+installation.  However, this is not necessary to do; you may install
  455
+slash 2.2 on top of the slash 2.0 installation.
  456
+<P>The reason to not move anything is that you can keep any customizations
  457
+done (images, additional scripts and plugins, static files, etc.).
  458
+The reason to move it is so that everything is clean.  It is highly
  459
+recommended that you move it, and then manually copy back the pieces
  460
+you want.</P>
  461
+<P></P>
  462
+<LI>
  463
+In any event, either move the old directory, or don't, and
  464
+then install slash 2.2 as normal.  Do not yet run install-slashsite.
  465
+<P></P></OL>
  466
+<LI>
  467
+If you have plugins or themes from the old installation to install,
  468
+copy them over now.  Warning: some plugins and themes might need to be
  469
+ported first.  You may wish to deal with them later if they are not
  470
+yet ported to slash 2.2.
  471
+<P></P>
  472
+<LI>
  473
+Run install-slashsite.  Use the new virtual user.
  474
+<P></P>
  475
+<LI>
  476
+Copy over any files (images, FAQs, etc.) that need to be copied, if necessary.
  477
+<P></P>
  478
+<LI>
  479
+Run update script, <EM>utils/slash2toslash2.2</EM>.  <STRONG>Read its instructions!</STRONG>
  480
+<P></P>
  481
+<LI>
  482
+Update templates.
  483
+<P></P>
  484
+<LI>
  485
+Doublecheck Apache configs (httpd/slash.conf, site/sitename/sitename.conf).
  486
+These configs have changed from the last version.  Read the comments and set
  487
+them up as desired.
  488
+<P></P>
  489
+<LI>
  490
+Start Apache.
  491
+<P></P>
  492
+<LI>
  493
+Start slashd.
  494
+<P></P></OL>
413 495
 <P>
414  
-<H2><A NAME="slash_2.0.x___slash_2.0.y">Slash 2.0.x -&gt; Slash 2.0.y</A></H2>
  496
+<H2><A NAME="slash_2.2.x___slash_2.2.y">Slash 2.2.x -&gt; Slash 2.2.y</A></H2>
415 497
 <P>Read all of this section before doing any of it.</P>
416 498
 <P>The first thing to do is to, as per the instructions below under
417 499
 INSTALLATION, unpack the latest distribution and run make and make
@@ -478,65 +560,12 @@
478 560
 <PRE>
479 561
         % template-tool -u VIRTUAL_USER -s LIST</PRE>
480 562
 <P></P></DL>
481  
-<DT><STRONG><A NAME="item_Data">Data</A></STRONG><BR>
482  
-<DD>
483  
-Currently, there are no differences in the schema between versions of Slash 2.0.
484  
-There are a few data differences.
485  
-<DL>
486  
-<DT><STRONG><A NAME="item_Slash">Slash 2.0.0-pre1 -&gt; Slash-2.0.0 release</A></STRONG><BR>
487  
-<DD>
488  
-<DL>
489  
-<DT><STRONG><A NAME="item_Journal_Data">Journal Data</A></STRONG><BR>
490  
-<DD>
491  
-In the vars table, "journal_default_display" is set to "0".  It should default
492  
-to "10".
493  
-<P>Also, "journal_user_count" is no longer in use and may be deleted.</P>
494  
-<P>See <EM>plugins/Journal/dump</EM>.</P>
495  
-<P></P>
496  
-<DT><STRONG><A NAME="item_Search_Data">Search Data</A></STRONG><BR>
497  
-<DD>
498  
-"search_default_display" should be defined in the vars table, with a default
499  
-of "30".
500  
-<P>See <EM>plugins/Search/dump</EM>.</P>
501  
-<P></P></DL>
502  
-</DL>
503  
-<DT><STRONG>Templates</STRONG><BR>
504  
-<DD>
505  
-Listed below are additions/deletions of templates from version to version.
506  
-Feel free to delete (or not) ones that are no longer used, but please do
507  
-add to your site templates that have been added to the distribution.  Add
508  
-or delete, for your site, all the changes from your current version up
509  
-through the version you're upgrading to.
510  
-<DL>
511  
-<DT><STRONG>Slash 2.0.0-pre2 -&gt; Slash 2.0.0</STRONG><BR>
512  
-<DD>
513  
-<DL>
514  
-<DT><STRONG><A NAME="item_Added">Added</A></STRONG><BR>
515  
-<DD>
516  
-<DL>
517  
-<DT><STRONG><A NAME="item_plugins%2FJournal%2Ftemplates%2Fpagination%3Bjourn">plugins/Journal/templates/pagination;journal;default</A></STRONG><BR>
518  
-<DD>
519  
-<DT><STRONG><A NAME="item_plugins%2FSearch%2Ftemplates%2Fpagination%3Bsearch">plugins/Search/templates/pagination;search;default</A></STRONG><BR>
520  
-<DD>
521  
-<DT><STRONG><A NAME="item_themes%2Fslashcode%2Ftemplates%2FdispLinkComment%3">themes/slashcode/templates/dispLinkComment;misc;default</A></STRONG><BR>
522  
-<DD>
523  
-</DL>
524  
-<DT><STRONG><A NAME="item_Deleted">Deleted</A></STRONG><BR>
525  
-<DD>
526  
-<DL>
527  
-<DT><STRONG><A NAME="item_plugins%2FJournal%2Ftemplates%2Fjournalitem%3Bjour">plugins/Journal/templates/journalitem;journal;default</A></STRONG><BR>
528  
-<DD>
529  
-<DT><STRONG><A NAME="item_plugins%2FSearch%2Ftemplates%2Flinksearch%3Bsearch">plugins/Search/templates/linksearch;search;default</A></STRONG><BR>
530  
-<DD>
531  
-</DL>
532  
-</DL>
533  
-</DL>
534 563
 </DL>
535 564
 <P>
536  
-<H2><A NAME="slash_1.0___slash_2.0">Slash 1.0 -&gt; Slash 2.0</A></H2>
537  
-<P>Please read the complete documentation of <EM>utils/slash1toslash2</EM>.
  565
+<H2><A NAME="slash_1.0___slash_2.2">Slash 1.0 -&gt; Slash 2.2</A></H2>
  566
+<P>Please read the complete documentation of <EM>utils/slash1toslash2.2</EM>.
538 567
 It is a program that will convert your database from Slash 1.0
539  
-to a new Slash 2.0 database.  The program documentation (which can
  568
+to a new Slash 2.2 database.  The program documentation (which can
540 569
 be read with <EM>perldoc</EM>) details exactly what process it follows
541 570
 to do the conversion, so you can attempt to do it by hand if you
542 571
 prefer.</P>
@@ -559,7 +588,7 @@
559 588
 <P></P>
560 589
 <DT><STRONG><A NAME="item_MySQL">MySQL</A></STRONG><BR>
561 590
 <DD>
562  
-Version 3.23.42 (3.23.23).
  591
+Version 3.23.42 (3.23).
563 592
 <PRE>
564 593
         <A HREF="http://www.mysql.com/">http://www.mysql.com/</A></PRE>
565 594
 <P></P>
@@ -591,7 +620,7 @@
591 620
 install them before installing the modules.</P>
592 621
 <PRE>
593 622
         <A HREF="http://www.gzip.org/zlib/">http://www.gzip.org/zlib/</A>
594  
-        <A HREF="http://sourceforge.net/projects/expat/">http://sourceforge.net/projects/expat/</A></PRE>
  623
+        <A HREF="http://sf.net/projects/expat/">http://sf.net/projects/expat/</A></PRE>
595 624
 <P>The following required distributions are all included in
596 625
 the Bundle::Slash distribution.</P>
597 626
 <DL>
@@ -685,6 +714,37 @@
685 714
 for load balancing and redundancy).</P>
686 715
 <P>
687 716
 <HR>
  717
+<H1><A NAME="versions">VERSIONS</A></H1>
  718
+<P>Each version of slash has a code name, and the files on CVS for that
  719
+version are tagged with that name.  The current release is always
  720
+MAIN.  The versioning scheme is as Linux and Perl are,
  721
+revision.version.subversion.  version is even for releases, and odd
  722
+for development.  The codename applies to the development version
  723
+and subsequent release.</P>
  724
+<P>For example, 1.0.11 is a normal release, while 1.1.0 is the first
  725
+development release for what will be the next release (either 1.2
  726
+or 2.0).</P>
  727
+<P>The CVS repository is tagged with version numbers, so to get release
  728
+1.0.3, use tag "v1_0_3_0".  The last number (in this case a zero) will
  729
+be incremented during development ("v1_0_3_1", "v1_0_3_2", etc.) until
  730
+the next release.</P>
  731
+<P>
  732
+<H2><A NAME="codenames">Codenames</A></H2>
  733
+<DL>
  734
+<DT><STRONG><A NAME="item_v1%2E0">v1.0</A></STRONG><BR>
  735
+<DD>
  736
+beast
  737
+<P></P>
  738
+<DT><STRONG><A NAME="item_v2%2E0">v2.0</A></STRONG><BR>
  739
+<DD>
  740
+bender
  741
+<P></P>
  742
+<DT><STRONG><A NAME="item_v2%2E2">v2.2</A></STRONG><BR>
  743
+<DD>
  744
+fry
  745
+<P></P></DL>
  746
+<P>
  747
+<HR>
688 748
 <H1><A NAME="version">VERSION</A></H1>
689 749
 <P>$Id$</P>
690 750
 
4  docs/INSTALL.pod
Source Rendered
@@ -636,11 +636,11 @@ template with the new template.
636 636
 
637 637
 =back
638 638
 
639  
-=head2 Slash 1.0 -E<gt> Slash 2.0
  639
+=head2 Slash 1.0 -E<gt> Slash 2.2
640 640
 
641 641
 Please read the complete documentation of F<utils/slash1toslash2.2>.
642 642
 It is a program that will convert your database from Slash 1.0
643  
-to a new Slash 2.0 database.  The program documentation (which can
  643
+to a new Slash 2.2 database.  The program documentation (which can
644 644
 be read with F<perldoc>) details exactly what process it follows
645 645
 to do the conversion, so you can attempt to do it by hand if you
646 646
 prefer.
22  docs/README.html
@@ -31,8 +31,9 @@
31 31
 <P>This release is <STRONG>BETA</STRONG> software.  It is not intended or recommended
32 32
 for production use, and is constantly changing.  Please use this only
33 33
 for development and testing purposes.</P>
34  
-<P>There are currently <STRONG>NO</STRONG> upgrade procedures in place for previous
35  
-versions of Slash.  Those will be coming in a subsequent beta.</P>
  34
+<P>The upgrade procedures are available (<EM>INSTALL</EM>).  Standard
  35
+disclaimer applies.  Please test them if you are so inclined, and
  36
+let us know how they work for you.</P>
36 37
 <P>
37 38
 <HR>
38 39
 <H1><A NAME="description">DESCRIPTION</A></H1>
@@ -58,7 +59,7 @@
58 59
 <P>As noted in the FAQ, please send any bug reports, and subscribe to
59 60
 mailing lists, at Slash's SourceForge site.</P>
60 61
 <PRE>
61  
-        <A HREF="http://sourceforge.net/projects/slashcode/">http://sourceforge.net/projects/slashcode/</A></PRE>
  62
+        <A HREF="http://sf.net/projects/slashcode/">http://sf.net/projects/slashcode/</A></PRE>
62 63
 <P>
63 64
 <HR>
64 65
 <H1><A NAME="documentation">DOCUMENTATION</A></H1>
@@ -115,14 +116,17 @@
115 116
 <DT><STRONG><A NAME="item_Schema">Schema</A></STRONG><BR>
116 117
 <DD>
117 118
 The layout and description of the database.  [These are out of date.]
118  
-<P><EM>docs/slasherd_bender.fig</EM></P>
119  
-<P><EM>docs/slasherd_bender.pdf</EM></P>
120  
-<P><EM>docs/slasherd_bender.ps</EM></P>
121  
-<P><EM>docs/slashtables_bender.pod</EM></P>
  119
+<P><EM>docs/slasherd.fig</EM></P>
  120
+<P><EM>docs/slasherd.ps</EM></P>
  121
+<P><EM>docs/slashtables.pod</EM></P>
122 122
 <P></P>
123 123
 <DT><STRONG><A NAME="item_Other">Other</A></STRONG><BR>
124 124
 <DD>
125  
-We need to upgrade the Getting Started document.
  125
+The slashguide document (previously called getting_started) helps
  126
+you get your feet wet and gives vital information for how to run
  127
+a Slash site.
  128
+<P><EM>docs/slashguide.pod</EM></P>
  129
+<P><EM>themes/slashcode/htdocs/slashguide.shtml</EM></P>
126 130
 <P></P>
127 131
 <DT><STRONG><A NAME="item_Authors">Authors</A></STRONG><BR>
128 132
 <DD>
@@ -151,7 +155,7 @@
151 155
 <DT><STRONG><A NAME="item_SourceForge_Site">SourceForge Site</A></STRONG><BR>
152 156
 <DD>
153 157
 Access to the code, bug reports, patches, mailing lists, and more.
154  
-<P><A HREF="http://sourceforge.net/projects/slashcode/">http://sourceforge.net/projects/slashcode/</A></P>
  158
+<P><A HREF="http://sf.net/projects/slashcode/">http://sf.net/projects/slashcode/</A></P>
155 159
 <P></P></DL>
156 160
 <P>
157 161
 <HR>

0 notes on commit 08084fc

Please sign in to comment.
Something went wrong with that request. Please try again.