Changes between Version 4 and Version 5 of 1.3/TracUpgrade

Timestamp:

Feb 9, 2017, 2:13:32 AM (7 years ago)

Author:

Ryan J Ollos

Comment:

Minor reword.

1.3/TracUpgrade

@@ -10 +10 @@
 === 1. Check your plugins
 
-Check whether your plugins are compatible with the version of Trac that you are upgrading to. Obsolete plugins listed in the [#VersionSpecificSteps version specific steps] below should be removed.
-
-If you are upgrading to a minor release, plugin compatibility is usually not a concern because the Trac API typically does not change and major features are not introduced for minor releases.
+Check whether your plugins are compatible with the version of Trac that you are upgrading to. Obsolete plugins listed in the [#VersionSpecificSteps version specific steps] below should be uninstalled or disabled.
+
+If you are upgrading to a minor release, plugin compatibility is usually not a concern because the Trac API typically does not change, and major features are not introduced, for minor releases.
 
 If your plugins are installed from [https://trac-hacks.org trac-hacks.org] you can check compatibility by looking for a tag on the project page corresponding to a major release (e.g. `1.2`). If you are unsure, you'll want to contact the plugin author or ask on the MailingList.
 
-If you are running several Trac plugins it may be a good idea to test the upgrade and site functionality in a staging instance of your site before upgrading your production instance. Remember, plugin authors are responsible for Trac version compatibility and plugins can interact in unexpected ways. You may be the only one running a particular combination of plugins and therefore it's a good idea to do some verification testing when making any changes to your site.
+If you are running several Trac plugins it is good to test the upgrade and site functionality in a staging instance of your site before upgrading your production instance. Remember, plugin authors are responsible for Trac version compatibility and plugins can interact in unexpected ways. Your Trac instance may have a unique combination of plugins and therefore it's a good idea to do some verification testing when making any changes to your site.
 
 === 2. Bring your server off-line
@@ -22 +22 @@
 It is not a good idea to update a running server: the server processes may have parts of the current packages cached in memory, and updating the code will likely trigger [#ZipImportError internal errors].
 
-Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning.
+Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning. You may also wish to create a full backup of your server.
 
 === 3. Update Trac and dependencies #UpdatetheTracCode
 
-The packages are available through several channels, as described in [trac:TracDownload]. If your Trac instance was installed through an operating system package manager or an installer on Windows, proceed with standard steps that are appropriate for your operating system.
+The packages are available through several channels, as described in [trac:TracDownload]. If your Trac instance was installed through an operating system package manager or an installer on Windows, proceed with the standard steps that are appropriate for your operating system.
 
 If you are managing your Trac installation using command line tools, `pip` is the preferred tool to upgrade a Trac instance because it will uninstall the old version. The following command will upgrade your Trac installation using the package published to [https://pypi.python.org/pypi/Trac PyPI].
@@ -68 +68 @@
 === 6. Refresh static resources
 
-If you have configured your web server to serve static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the [TracInstall#MappingStaticResources same command]. The `deploy` command will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`.
+If you have configured your web server to serve static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the [TracInstall#MappingStaticResources deploy command]. The `deploy` command will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`.
 {{{#!sh
 $ trac-admin /path/to/env deploy /deploy/path
 }}}
 
-Before refreshing, you may want to remove the directory in which your static resources are deployed. The directory location depends on the choice you made during installation. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before deleting the directory.
+Before refreshing, it is recommended that you remove the directory in which your static resources are deployed. The directory location depends on the choice you made during installation. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before deleting the directory.
 
 {{{#!div style="border: 1pt dotted; margin: 1em"
-**Note:** Some web browsers (IE, Opera) cache CSS and Javascript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be enough.
+**Note:** Some web browsers (IE, Opera) cache CSS and Javascript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be sufficient.
 {{{#!comment
 Remove above note once #9936 is fixed.
@@ -99 +99 @@
 (TODO: expand...)
 
-Another "template" that will probably need to be updated are the e-mail notificition summaries, defined in the [[TracIni#notification-section| trac.ini, [notification] section]], for the `batch_subject_template` and `ticket_subject_template` settings.
+Another "template" that will probably need to be updated are the e-mail notification summaries, defined in the [[TracIni#notification-section| trac.ini, [notification] section]], for the `batch_subject_template` and `ticket_subject_template` settings.
 
 For example: