refine README and recent release notes
authorDenis Ovsienko <infrastation@yandex.ru>
Fri, 8 Nov 2013 08:55:22 +0000 (12:55 +0400)
committerDenis Ovsienko <infrastation@yandex.ru>
Fri, 8 Nov 2013 08:55:22 +0000 (12:55 +0400)
Reword assorted sentences and reformat release notes to meet the common
line length.

README
wwwroot/inc/upgrade.php

diff --git a/README b/README
index f3be1dc50af55b2bb17a5a4369f2ea06e6c353c2..8efbaf7db9a237bd4ec287ecb6cc641d62dede32 100644 (file)
--- a/README
+++ b/README
@@ -68,12 +68,13 @@ section of "/etc/my.cnf" file and restart mysqld.
 # make -C /usr/ports/net/php5-ldap install
 
 *** II. FILES ***
-Unpack distro files to any directory you want and configure Apache to "wwwroot"
-subdirectory as DocumentRoot. Symlinks to wwwroot or even index.php from your
-web server root are also possible.
+Unpack the tar.gz/zip archive to a directory of your choice and configure Apache
+httpd to use "wwwroot" subdirectory as a new DocumentRoot. Alternatively,
+symlinks to "wwwroot" or even to "index.php" from an existing DocumentRoot are
+also possible and often adisable (see README.Fedora).
 
 *** III. INSTALLER ***
-Open your configured RackTables URL and you will be prompted to configure
+Open the configured RackTables URL and you will be prompted to configure
 and initialize the application.
 
 *******************************************************
@@ -81,20 +82,16 @@ and initialize the application.
 *              UPGRADING RACKTABLES                   *
 *                                                     *
 *******************************************************
-RackTables (since 0.14.6) provides an automatic database upgrade feature.
-If you already have a working installation, the following procedure
-should be sufficient:
-
-0. BACKUP YOUR DATABASE and check the release notes (below) before actually
-   starting the upgrade,.
-1. Remove all existing files except inc/secret.php and the gateways'
-   configuration (in the gateways directory).
-2. Unpack the new tarball into the place.
-3. Open your RackTables page in a browser. The software detects version
-   mismatch and displays a message telling to log in as admin to finish
+
+0. BACKUP YOUR DATABASE and check the release notes below before actually
+   starting the upgrade.
+1. Remove all existing files except configuration (the "inc/secret.php" file)
+   and local plugins (in the "plugins" directory).
+2. Put the contents of the new tar.gz/zip archive into the place.
+3. Open the RackTables page in a browser. The software will detect version
+   mismatch and display a message telling to log in as admin to finish
    the upgrade.
-4. Do that. Normally, everything should be Ok. If there are
-   errors displayed, send these in a bug report.
+4. Do that and report any errors to the bug tracker or the mailing list.
 
 *******************************************************
 *                                                     *
@@ -104,32 +101,35 @@ should be sufficient:
 
 *** Upgrading to 0.20.6 ***
 
-Database triggers are used for some data consistency measures.  The database
+This release uses database triggers for consistency measures.  The database
 user account must have the 'TRIGGER' privilege, which was introduced in
 MySQL 5.1.7.
 
 Cable paths can be traced and displayed in a graphical format. This requires
 the Image_GraphViz PEAR module (http://pear.php.net/package/Image_GraphViz).
 
-Config variables TELNET_OBJS_LISTSRC, SSH_OBJS_LISTSRC, RDP_OBJS_LISTSRC were merged into new MGMT_PROTOS.
-The old ones were deleted from the DB. MGMT_PROTOS allows to specify any management protocol for a particular
-device list by RackCode filter. The default value is 'ssh: {\$typeid_4}, telnet: {\$typeid_8}' which leads to
-object's FQDN linked to 'ssh://server.fqdn' and 'telnet://switch.fqdn'. If the old variables contained any data,
-it will be converted to the new syntax and stored into MGMT_PROTOS variable.
+New MGMT_PROTOS configuration option replaces the TELNET_OBJS_LISTSRC,
+SSH_OBJS_LISTSRC and RDP_OBJS_LISTSRC options (converting existing settings as
+necessary). MGMT_PROTOS allows to specify any management protocol for a
+particular device list using a RackCode filter. The default value
+("ssh: {$typeid_4}, telnet: {$typeid_8}") produces "ssh://server.fqdn" for
+servers and "telnet://switch.fqdn" for network switches.
 
 *** Upgrading to 0.20.5 ***
 
 This release introduces the VS groups feature. VS groups is a new way to store
-and display virtual services configuration. New realm 'ipvs' (VS group) is created.
-All the existing VS configuration is kept and displayed as-is, but user is free to convert
-it to the new format, which displays it in more natural way and allows to generate
-virtual_server_group keepalived configs. To convert a virtual service to the new format,
-you need to manually create the vs group object and assign IP addresses to it. Then, if you
-have the old-style VSes configured, the Migrate tab will be displayed on the particular VS group's
-page. After successfull migration, you can remove the old-style VS objects.
-
-Old-style VS configuration becomes DEPRECATED. Its support will be removed in one of the following
-major releases. So it is strongly recommended to convert it to the new format.
+and display virtual services configuration. There is a new "ipvs" (VS group)
+realm. All previously existing VS configuration remains functional and user
+is free to convert it to the new format, which displays it in a more natural way
+and allows to generate virtual_server_group keepalived configs. To convert a
+virtual service to the new format, it is necessary to manually create a VS group
+object and assign IP addresses to it. The VS group will display a "Migrate" tab
+to convert the old-style VS objects, which can be removed after a successful
+conversion.
+
+The old-style VS configuration becomes DEPRECATED. Its support will be removed
+in a future major release. So it is strongly recommended to convert it to the
+new format.
 
 *** Upgrading to 0.20.4 ***
 
index d547b2ad596ddb7ea7aee6287f6c60858ef08447..4ae2d194b90b9437ee90c21c14e1fb747d8d8894 100644 (file)
@@ -187,32 +187,35 @@ ENDOFTEXT
 
        '0.20.5' => <<<ENDOFTEXT
 This release introduces the VS groups feature. VS groups is a new way to store
-and display virtual services configuration. New realm 'ipvs' (VS group) is created.
-All the existing VS configuration is kept and displayed as-is, but user is free to convert
-it to the new format, which displays it in more natural way and allows to generate
-virtual_server_group keepalived configs. To convert a virtual service to the new format,
-you need to manually create the vs group object and assign IP addresses to it. Then, if you
-have the old-style VSes configured, the Migrate tab will be displayed on the particular VS group's
-page. After successfull migration, you can remove the old-style VS objects.
-
-Old-style VS configuration becomes DEPRECATED. Its support will be removed in one of the following
-major releases. So it is strongly recommended to convert it to the new format.
+and display virtual services configuration. There is a new "ipvs" (VS group)
+realm. All previously existing VS configuration remains functional and user
+is free to convert it to the new format, which displays it in a more natural way
+and allows to generate virtual_server_group keepalived configs. To convert a
+virtual service to the new format, it is necessary to manually create a VS group
+object and assign IP addresses to it. The VS group will display a "Migrate" tab
+to convert the old-style VS objects, which can be removed after a successful
+conversion.
+
+The old-style VS configuration becomes DEPRECATED. Its support will be removed
+in a future major release. So it is strongly recommended to convert it to the
+new format.
 ENDOFTEXT
 ,
 
        '0.20.6' => <<<ENDOFTEXT
-0.20.6 uses database triggers for consistency measures.  The database
+This release uses database triggers for consistency measures.  The database
 user account must have the 'TRIGGER' privilege, which was introduced in
 MySQL 5.1.7.
 
 Cable paths can be traced and displayed in a graphical format. This requires
 the Image_GraphViz PEAR module (http://pear.php.net/package/Image_GraphViz).
 
-Config variables TELNET_OBJS_LISTSRC, SSH_OBJS_LISTSRC, RDP_OBJS_LISTSRC were merged into new MGMT_PROTOS.
-The old ones were deleted from the DB. MGMT_PROTOS allows to specify any management protocol for a particular
-device list by RackCode filter. The default value is 'ssh: {\$typeid_4}, telnet: {\$typeid_8}' which leads to
-object's FQDN linked to 'ssh://server.fqdn' and 'telnet://switch.fqdn'. If the old variables contained any data,
-it will be converted to the new syntax and stored into MGMT_PROTOS variable.
+New MGMT_PROTOS configuration option replaces the TELNET_OBJS_LISTSRC,
+SSH_OBJS_LISTSRC and RDP_OBJS_LISTSRC options (converting existing settings as
+necessary). MGMT_PROTOS allows to specify any management protocol for a
+particular device list using a RackCode filter. The default value
+("ssh: {\$typeid_4}, telnet: {\$typeid_8}") produces "ssh://server.fqdn" for
+servers and "telnet://switch.fqdn" for network switches.
 ENDOFTEXT
 ,
 );