From 50f2834a0ae2a9f9f2ac53439184ebdc04db2f54 Mon Sep 17 00:00:00 2001 From: Ryan Cramer Date: Fri, 23 Sep 2016 11:52:25 -0400 Subject: [PATCH] Additional README updates --- README.md | 46 ++++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c384de97..e768b0ef 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ This document is in Markdown. An HTML formatted version of this document can be read at: https://github.com/processwire/processwire/blob/master/README.md + ## Table of Contents 1. [About](#about-processwire) @@ -11,6 +12,7 @@ can be read at: https://github.com/processwire/processwire/blob/master/README.md 4. [Troubleshooting](https://processwire.com/docs/install/troubleshooting/) 5. [Support](#support-and-links) + ## About ProcessWire ProcessWire is an open source content management system (CMS) and web @@ -51,29 +53,24 @@ Chances are that you can upgrade simply by replacing the /wire/ directory. ### Upgrading from ProcessWire 2.x If upgrading from ProcessWire 2.5 or older, we recommend that you upgrade -to ProcessWire 2.7 or 2.8 first. Both of those versions include details in the -README file on how to upgrade from these older versions of ProcessWire. - -* ProcessWire 2.8: -* ProcessWire 2.7: - -To upgrade from ProcessWire 2.6 (or newer) to ProcessWire 3.x, please follow the -instructions below. +to ProcessWire [2.8](https://github.com/processwire/processwire-legacy) or +[2.7](https://github.com/ryancramerdesign/processwire) first. Both of those +versions include details in the README file on how to upgrade from these +older versions of ProcessWire. To upgrade from ProcessWire 2.6 (or newer) +to ProcessWire 3.x, please follow the instructions below. 1. Login to the admin of your site. -2. Edit your /site/config.php and set `$config->debug = true;` to ensure you can - see error messages. +2. Edit your `/site/config.php` file and set `$config->debug = true;` to ensure + you can see error messages. This is optional but recommended. -3. Replace your /wire/ directory and /index.php file with the ones from here. - Don't forget the /index.php as it is definitely required (it will tell you - if you forget). +3. Replace your `/wire/` directory and `/index.php` file with the new ones from here. -4. Click a tab page in your admin, such as "Pages". You may notice a delay. +4. Click a navigation link in your admin, such as "Pages". You may notice a delay. This is ProcessWire compiling 3rd party modules into a format that is compatible with version 3.x. Keep an eye out for any error messages. If you see any issues, it's possible you may need to upgrade one or more - 3rd party modules. If you see messages about it apply updates, keep hitting + 3rd party modules. If you see messages about it applying updates, keep hitting reload in your browser until you no longer see any update messages. 5. Once you've resolved error messages in your admin, you'll want to test out @@ -88,22 +85,26 @@ instructions below. `$config->debug` setting back to `false` in your /site/config.php file. **Troubleshooting a 3.x upgrade** -If you run into any trouble upgrading, please see our Troubleshooting an Upgrade -guide located at +If you run into any trouble upgrading, please see our troubleshooting guide +located at . ### Pro module upgrade notes -- If using FormBuilder, we recommend using only v0.3.0 or newer. -- If using ProCache, we recommend using only v3.1.4 or newer. -- If using ListerPro, we recommend using only v1.0.9 or newer. +- If using [FormBuilder](https://processwire.com/api/modules/form-builder/), + we recommend using only v0.3.0 or newer. +- If using [ProCache](https://processwire.com/api/modules/procache/), + we recommend using only v3.1.4 or newer. +- If using [ListerPro](https://processwire.com/api/modules/lister-pro/), + we recommend using only v1.0.9 or newer. +- If using [ProFields](https://processwire.com/api/modules/profields/), + we recommend grabbing the latest versions in the ProFields support board. - If using ProCache and you upgraded your .htaccess file, you should go to your ProCache settings after the upgrade to have it update your .htaccess file again. If no upgrades to your .htaccess file are necessary, then the ProCache settings page won't mention it. - ## Debug Mode Debug mode causes all errors to be reported to the screen, which can be @@ -131,10 +132,11 @@ resolved any issues. ## Support and Links * [ProcessWire Support](https://processwire.com/talk/) +* [ProcessWire Weekly](https://weekly.pw/) +* [ProcessWire Blog](https://processwire.com/blog/) * [Follow @processwire on Twitter](http://twitter.com/processwire/) * [Contact ProcessWire](https://processwire.com/contact/) * [Sites running ProcessWire](https://processwire.com/about/sites/) -* [Read the ProcessWire Blog](https://processwire.com/blog/) ------