Item13883: Clarify when the upgrade procedure is required.

foswiki · May 7, 2017 · d87cdb8 · d87cdb8
1 parent cc9bd39
commit d87cdb8
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/core/data/System/UpgradeGuide.txt b/core/data/System/UpgradeGuide.txt
@@ -1,12 +1,19 @@
-%META:TOPICINFO{author="ProjectContributor" comment="" date="1493146093" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1494199312" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="AdminDocumentationCategory"}%
 %STARTINCLUDE%
 ---+ Foswiki Upgrade Guide
 
-This guide covers upgrading from a previous version of Foswiki to Foswiki 2.0
+This guide covers upgrading from a previous version of Foswiki to Foswiki 2.x.
 
 <!-- Document writers. Please note that this document is distributed in HTML version in the root of the distribution. You cannot use WikiWord links or any other local linking. -->
 
+<div class='foswikiHelp' style='border:2px orange solid' >
+%X% This upgrade procedure is used to upgrade a
+to a new *major version* of Foswiki (<b>1.x</b> to <b> 2.x</b>) or from TWiki. Generally, upgrades of
+a minor Foswiki version (2.0 to 2.1), or Foswiki patch releases (2.1.3 to 2.1.4) can be done by using the
+=-upgrade-= version of the Foswiki package, and follow the Release Notes for the new
+release.</div>
+
 %TOC%
 
 ---++ Overview
@@ -22,7 +29,7 @@ If you are upgrading from TWiki to Foswiki, please refer to Foswiki:Support.Upgr
    * Before upgrading, a backup of your topics is strongly recommended.
    * Once the upgrade has been applied, an existing earlier installation will still be able to read all the topics, but should not be used to write.
 
----++ Upgrading to a new patch release
+---++ Upgrading to a new patch or minor release
 
 To upgrade to a new patch release &mdash; for example, from Foswiki 1.1.0 to 1.1.2 &mdash; an upgrade package can be used that will not overwrite typical customizations. Unless otherwise stated in the release notes, we do not recommend upgrading between major or minor versions using the patch (For ex. 1.1.9 to 2.0). A re-installation is recommended.
 
@@ -97,7 +104,7 @@ For patch releases you will find a brief upgrade procedure on the download page
 %T% If you use the Foswiki !PageCaching feature, be sure to refresh the cache after upgrading to a new Foswiki version. Visit your site with the Query parameter =?refresh=all=
 </div>
 
----++ Upgrade procedure: upgrading to a new major or minor version
+---++ Upgrade procedure: upgrading to a new major version
 
 The following is a high level view of the upgrade procedure: