Merge pull request #108 from humanmade/backport-107-to-v3-branch

[Backport v3-branch] Add SUNRISE info and migration guide links
humanmade · Dec 18, 2019 · 6a2ac1b · 6a2ac1b
2 parents 013d74d + d8157b0
commit 6a2ac1b
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/other-docs/guides/migrating-from-wordpress.md b/other-docs/guides/migrating-from-wordpress.md
@@ -92,11 +92,23 @@ The `SUBDOMAIN_INSTALL` constant is not required any more but may have been pres
 If you still require this constant for any reason then you must wrap it in a check to see if WordPress is in its initial installation step:
 
 ```php
-if ( ! defined( 'WP_INITIAL_INSTALL' ) ) {
+if ( ! defined( 'WP_INITIAL_INSTALL' ) || ! WP_INITIAL_INSTALL ) {
 	define( 'SUBDOMAIN_INSTALL', true );
 }
 ```
 
+## Ensure `SUNRISE` is not defined during install
+
+The `SUNRISE` constant puts WordPress into multisite mode which will cause problems during the initial installation.
+
+If your site uses `sunrise.php` update the code where you define `SUNRISE` like so:
+
+```php
+if ( ! defined( 'WP_INITIAL_INSTALL' ) || ! WP_INITIAL_INSTALL ) {
+	define( 'SUNRISE', true );
+}
+```
+
 ## Rename content/plugins-mu to content/mu-plugins
 
 Altis uses the standard WordPress must-use plugins directory of `content/mu-plugins` so if your project is using something different, it should be renamed.

diff --git a/other-docs/guides/upgrading/README.md b/other-docs/guides/upgrading/README.md
@@ -1,5 +1,7 @@
 # Upgrading
 
+_If you are migrating an existing install to Altis check out the [migrating guide here](../migrating-from-wordpress.md) first._
+
 When new versions of Altis are released you will need to manually upgrade your project to the new version. New versions can bring anything from breaking changes to new features. It's important you read the changelog / upgrade notes for the specific version you are upgrading to. When upgrading multiple versions at once, be sure to follow the release notes on all intermediate versions.
 
 To switch the version of Altis for your project, modify the version constraint for the `altis/altis` dependency in your `composer.json`. For example, to upgrade to Altis version 2.

diff --git a/other-docs/guides/upgrading/v2.md b/other-docs/guides/upgrading/v2.md
@@ -1,5 +1,7 @@
 # Upgrading to v2
 
+_If you are migrating an existing install to Altis check out the [migrating guide here](../migrating-from-wordpress.md) first._
+
 To upgrade to Altis v2, edit your `composer.json` and change the version constraint for `altis/altis` to `^2.0.0`:
 
 ```json

diff --git a/other-docs/guides/upgrading/v3.md b/other-docs/guides/upgrading/v3.md
@@ -1,5 +1,7 @@
 # Upgrading to v3
 
+_If you are migrating an existing install to Altis check out the [migrating guide here](../migrating-from-wordpress.md) first._
+
 To upgrade to Altis v3, edit your `composer.json` and change the version constraint for `altis/altis` and any local environment modules to `^3.0.0`:
 
 ```json
@@ -78,7 +80,7 @@ Good security is a growing concern online, and the new [browser security](docs:/
 
 ## Other Developer Features and APIs
 
-### Core Module Loading (Core Module)
+### Module Loading (Core Module)
 
 Modules were previously loaded via Composer's autoload functionality, however this approach was limiting, as the entrypoint files contained side-effects and required a `function_exists()` check at the start of the file to prevent non-Altis CLI commands from breaking.