From c94722ac44ba9aca05523ff726e3e2feb88a42a2 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 14:05:34 -0500 Subject: [PATCH 1/8] Added include for deprecation note --- src/_includes/install/web/deprecated.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 src/_includes/install/web/deprecated.md diff --git a/src/_includes/install/web/deprecated.md b/src/_includes/install/web/deprecated.md new file mode 100644 index 00000000000..15bb77264fb --- /dev/null +++ b/src/_includes/install/web/deprecated.md @@ -0,0 +1,2 @@ +{:.bs-callout-warning} +The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) to install Magento aftere the Web Setup Wizard is removed. From ce7f27b828fa7111f060f01cabd9b6efc624be9c Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 14:33:56 -0500 Subject: [PATCH 2/8] Added deprecation note to all inline references of the web setup wizard --- src/_includes/install/composer-overview.md | 2 ++ src/_includes/install/file-system-perms-before.md | 2 ++ src/_includes/install/file-system-perms-before_22.md | 2 ++ src/_includes/install/flow-diagram.md | 2 ++ src/_includes/install/get-software_zip.md | 2 ++ src/_includes/install/tls-repo.md | 2 ++ src/cloud/before/before-setup-env-install.md | 2 ++ src/guides/v2.3/frontend-dev-guide/themes/theme-install.md | 2 ++ src/guides/v2.3/install-gde/bk-install-guide.md | 2 ++ src/guides/v2.3/install-gde/composer.md | 2 ++ src/guides/v2.3/install-gde/continue-to-install.md | 3 +++ src/guides/v2.3/install-gde/install-quick-ref.md | 2 ++ .../install-gde/install/cli/install-cli-subcommands-db-upgr.md | 3 +++ .../install-gde/install/web/install-web-sample-data-clone.md | 2 ++ .../install/web/install-web-sample-data-composer.md | 2 ++ src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md | 2 ++ src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md | 2 ++ src/guides/v2.3/performance-best-practices/hardware.md | 2 ++ 18 files changed, 38 insertions(+) diff --git a/src/_includes/install/composer-overview.md b/src/_includes/install/composer-overview.md index f8d0b40e67a..0fe85e33126 100644 --- a/src/_includes/install/composer-overview.md +++ b/src/_includes/install/composer-overview.md @@ -8,3 +8,5 @@ We use [Composer](https://getcomposer.org/){:target="_blank"} to manage Magento {:.bs-callout-warning} You must create a Composer project from our metapackage if you want to use the Magento Web Setup Wizard to upgrade the Magento software and third-party extensions. + +{% include install/web/deprecated.md %} diff --git a/src/_includes/install/file-system-perms-before.md b/src/_includes/install/file-system-perms-before.md index c65daabe61c..fa0af9718a3 100644 --- a/src/_includes/install/file-system-perms-before.md +++ b/src/_includes/install/file-system-perms-before.md @@ -2,6 +2,8 @@ This topic discusses how to set read-write permissions for the web server group before you install the Magento software. This is necessary so the Setup Wizard or command line can write files to the Magento file system. +{% include install/web/deprecated.md %} + The procedure you use is different, depending on whether you use [shared hosting](#perms-shared) and have one user or if you use a [private server](#perms-private) and have two users. {:.bs-callout-info} diff --git a/src/_includes/install/file-system-perms-before_22.md b/src/_includes/install/file-system-perms-before_22.md index b0e58a43378..2f803f78c8d 100644 --- a/src/_includes/install/file-system-perms-before_22.md +++ b/src/_includes/install/file-system-perms-before_22.md @@ -2,6 +2,8 @@ This topic discusses how to set read-write permissions for the web server group before you install the Magento software. This is necessary so the Setup Wizard or command line can write files to the Magento file system. +{% include install/web/deprecated.md %} + The procedure you use is different, depending on whether you use [shared hosting](#perms-shared) and have one user or if you use a [private server](#perms-private) and have two users. {:.bs-callout-info} diff --git a/src/_includes/install/flow-diagram.md b/src/_includes/install/flow-diagram.md index 4b28bd4cb76..93a6c47ebe7 100644 --- a/src/_includes/install/flow-diagram.md +++ b/src/_includes/install/flow-diagram.md @@ -19,6 +19,8 @@ The diagram shows the following: 1. Install the Magento software using either the Web Setup Wizard or command line. + {% include install/web/deprecated.md %} + For simplicity, only the Web Setup Wizard is shown in the diagram. At each step, the Web Setup Wizard validates the information you entered. As shown in the preceding diagram, if validation fails, you must manually fix the issues before you proceed. diff --git a/src/_includes/install/get-software_zip.md b/src/_includes/install/get-software_zip.md index 501ca0e20f9..02ea4ddc794 100644 --- a/src/_includes/install/get-software_zip.md +++ b/src/_includes/install/get-software_zip.md @@ -5,6 +5,8 @@ The following table discusses where to get the Magento software. We provide the These packages are easy to get and install. You don't need to use Composer, all you need to do is to upload a package to your Magento server or hosted platform, unpack it, and run the web-based Setup Wizard. +{% include install/web/deprecated.md %} + Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz` diff --git a/src/_includes/install/tls-repo.md b/src/_includes/install/tls-repo.md index 0c76b6c6a6d..3a0ef56c0ed 100644 --- a/src/_includes/install/tls-repo.md +++ b/src/_includes/install/tls-repo.md @@ -20,6 +20,8 @@ failed to open stream: operation failed ### Using the Web Setup Wizard +{% include install/web/deprecated.md %} + Actions like saving your authentication credentials or synchronizing with Magento Marketplace fail with the following error: ![SSL connect error]({{ site.baseurl }}/common/images/install_ssl-connect-error.png) diff --git a/src/cloud/before/before-setup-env-install.md b/src/cloud/before/before-setup-env-install.md index cee97dde944..23967a0bb10 100644 --- a/src/cloud/before/before-setup-env-install.md +++ b/src/cloud/before/before-setup-env-install.md @@ -108,6 +108,8 @@ Be ready to install Magento using one of the following options: - [Install the Magento software using the command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) - [Install the Magento software using the Web Setup Wizard]({{ site.baseurl }}/guides/v2.3/install-gde/install/web/install-web.html) + {% include install/web/deprecated.md %} + {:.procedure} To install Magento using the command line: diff --git a/src/guides/v2.3/frontend-dev-guide/themes/theme-install.md b/src/guides/v2.3/frontend-dev-guide/themes/theme-install.md index 1a76d441076..c2ae5b10862 100644 --- a/src/guides/v2.3/frontend-dev-guide/themes/theme-install.md +++ b/src/guides/v2.3/frontend-dev-guide/themes/theme-install.md @@ -16,6 +16,8 @@ To install a theme, you need to add its code to your Magento 2 instance code bas - if a theme is a [composer](https://glossary.magento.com/composer) package, install it using composer. - if a theme is distributed as an extension, use the **Web Setup Wizard** in [Magento Admin](https://glossary.magento.com/magento-admin). + {% include install/web/deprecated.md %} + The following sections contain more information about each installation flow. ## Prerequisites diff --git a/src/guides/v2.3/install-gde/bk-install-guide.md b/src/guides/v2.3/install-gde/bk-install-guide.md index 288d8cf2710..6de0af82e71 100644 --- a/src/guides/v2.3/install-gde/bk-install-guide.md +++ b/src/guides/v2.3/install-gde/bk-install-guide.md @@ -20,6 +20,8 @@ Check the availability of exciting new features and releases, and learn how you Consult the following table for getting started with installing {{site.data.var.ce}} or {{site.data.var.ee}}. +{% include install/web/deprecated.md %} +
diff --git a/src/guides/v2.3/install-gde/composer.md b/src/guides/v2.3/install-gde/composer.md index 328bfe0e085..f787857fc8e 100644 --- a/src/guides/v2.3/install-gde/composer.md +++ b/src/guides/v2.3/install-gde/composer.md @@ -128,6 +128,8 @@ For a full description of the CLI install options, refer to [Install the Magento ### Web Setup Wizard +{% include install/web/deprecated.md %} + As an alternative to the CLI, use your browser to navigate to Magento's setup wizard: ```terminal diff --git a/src/guides/v2.3/install-gde/continue-to-install.md b/src/guides/v2.3/install-gde/continue-to-install.md index 83d4be6e17e..4b8bebd94bb 100644 --- a/src/guides/v2.3/install-gde/continue-to-install.md +++ b/src/guides/v2.3/install-gde/continue-to-install.md @@ -19,6 +19,9 @@ Totally lost? Need a helping hand? Try our [installation quick reference (tutori Now that you've installed prerequisites and taken the first steps (merchant, system integrator, or developer), you're ready to install the Magento software in any of the following ways: * Using the web-based [Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html), which is better for less experienced users or anyone who has a hosting provider (especially if you don't have access to the Magento server) + + {% include install/web/deprecated.md %} + * [Command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html), which gives you more control but requires more experience and also access to the Magento server ## Already installed the Magento software? diff --git a/src/guides/v2.3/install-gde/install-quick-ref.md b/src/guides/v2.3/install-gde/install-quick-ref.md index 8aaecddf05e..d1d1ee9415d 100644 --- a/src/guides/v2.3/install-gde/install-quick-ref.md +++ b/src/guides/v2.3/install-gde/install-quick-ref.md @@ -117,6 +117,8 @@ php magento deploy:mode:set developer ### Web Setup Wizard +{% include install/web/deprecated.md %} + {% collapsible Click to view the Web Setup Wizard installation %} The following example shows how to install using the Web Setup Wizard with the following options: diff --git a/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-db-upgr.md b/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-db-upgr.md index c3e0f9591af..35389ccc76d 100644 --- a/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-db-upgr.md +++ b/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-db-upgr.md @@ -26,6 +26,9 @@ Anytime you perform an action that causes the Magento [database schema](https:// Note the following: * If you used the Web Setup Wizard to do any of the preceding, you don't have to use the command discussed in this topic. + + {% include install/web/deprecated.md %} + * A Magento *component* can be a module, theme, or language pack; it doesn't matter whether the component comes from the Magento Marketplace or not 1. Start the upgrade: diff --git a/src/guides/v2.3/install-gde/install/web/install-web-sample-data-clone.md b/src/guides/v2.3/install-gde/install/web/install-web-sample-data-clone.md index 4cf798e963f..5711ee3b453 100644 --- a/src/guides/v2.3/install-gde/install/web/install-web-sample-data-clone.md +++ b/src/guides/v2.3/install-gde/install/web/install-web-sample-data-clone.md @@ -16,3 +16,5 @@ functional_areas: ### Install the Magento software After sample data installation is complete, install the Magento software using the [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html). + +{% include install/web/deprecated.md %} diff --git a/src/guides/v2.3/install-gde/install/web/install-web-sample-data-composer.md b/src/guides/v2.3/install-gde/install/web/install-web-sample-data-composer.md index 132b7ce7fa0..e2b0be86ce2 100644 --- a/src/guides/v2.3/install-gde/install/web/install-web-sample-data-composer.md +++ b/src/guides/v2.3/install-gde/install/web/install-web-sample-data-composer.md @@ -16,3 +16,5 @@ functional_areas: ### Install the Magento software After sample data installation is complete, install the Magento software using the [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html). + +{% include install/web/deprecated.md %} diff --git a/src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md b/src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md index d05f2734be2..853553aac59 100644 --- a/src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md +++ b/src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md @@ -17,6 +17,8 @@ This topic applies to you *only* if you [cloned the Magento 2 GitHub repository] Errors similar to the following display when you run the Web Setup Wizard: +{% include install/web/deprecated.md %} + ```terminal Magento\Framework\Exception Command returned non-zero exit code: diff --git a/src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md b/src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md index 9569825d873..b47720b1c9d 100644 --- a/src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md +++ b/src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md @@ -19,6 +19,8 @@ This topic describes how to change the Apache [docroot]({{ page.baseurl }}/insta {:.bs-callout-warning} If you're accustomed to using the Web Setup Wizard during development, be aware that you will not be able to access it when serving files from the `pub/` directory. +{% include install/web/deprecated.md %} + ## A note about nginx If you are using [nginx]({{ page.baseurl }}/install-gde/prereq/nginx.html) and the [`nginx.conf.sample`]({{ site.mage2bloburl }}/{{ page.guide_version }}/nginx.conf.sample) file included in the Magento installation directory, you are probably already serving files from the `pub/` directory. diff --git a/src/guides/v2.3/performance-best-practices/hardware.md b/src/guides/v2.3/performance-best-practices/hardware.md index 621c479a92f..0183ca91227 100644 --- a/src/guides/v2.3/performance-best-practices/hardware.md +++ b/src/guides/v2.3/performance-best-practices/hardware.md @@ -21,6 +21,8 @@ If you expect a store's load to change, you can manually increase the number of Magento 2 has differing PHP memory requirements, based on how your system is deployed. In general, if you are setting up a single server store and plan on using the web setup wizard, we recommend configuring PHP memory for 2G. If you are setting up a site using pipeline deployment, we recommend 2 GB on your build server and 1 GB on your web nodes. +{% include install/web/deprecated.md %} + Scenarios and expected PHP memory requirements: * Webnode serving only storefront pages: 256 MB From 25f18b6fe32bab882fedf9cd308c2e5c4b46861d Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 15:10:52 -0500 Subject: [PATCH 3/8] Added banner message for all files in web setup directory --- src/_includes/layout/page-header.html | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/_includes/layout/page-header.html b/src/_includes/layout/page-header.html index 9dd1c9f5c31..0a22a96f44a 100644 --- a/src/_includes/layout/page-header.html +++ b/src/_includes/layout/page-header.html @@ -1,6 +1,12 @@
+ {% if page.url contains "guides/v2.3/install-gde/install/web/" %} +
+ The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to install Magento after the Web Setup Wizard is removed. +
+ {% endif %} +

{{ page.title }}

{% if page.subtitle %} From 30752a151a87ac718e9d297d61da749a7950eb51 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 15:23:50 -0500 Subject: [PATCH 4/8] Fixed trailing space and link syntax for cloud include --- src/_includes/install/get-software_zip.md | 2 +- src/_includes/install/web/deprecated.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_includes/install/get-software_zip.md b/src/_includes/install/get-software_zip.md index 02ea4ddc794..fb330ac5dbc 100644 --- a/src/_includes/install/get-software_zip.md +++ b/src/_includes/install/get-software_zip.md @@ -5,7 +5,7 @@ The following table discusses where to get the Magento software. We provide the These packages are easy to get and install. You don't need to use Composer, all you need to do is to upload a package to your Magento server or hosted platform, unpack it, and run the web-based Setup Wizard. -{% include install/web/deprecated.md %} +{% include install/web/deprecated.md %} Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz` diff --git a/src/_includes/install/web/deprecated.md b/src/_includes/install/web/deprecated.md index 15bb77264fb..2c300a3632e 100644 --- a/src/_includes/install/web/deprecated.md +++ b/src/_includes/install/web/deprecated.md @@ -1,2 +1,2 @@ {:.bs-callout-warning} -The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) to install Magento aftere the Web Setup Wizard is removed. +The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) to install Magento aftere the Web Setup Wizard is removed. From 770b88f46d3ba3f80683d02150748c1a05b34ef4 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 17:02:41 -0500 Subject: [PATCH 5/8] Update src/_includes/install/web/deprecated.md Co-authored-by: hguthrie --- src/_includes/install/web/deprecated.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_includes/install/web/deprecated.md b/src/_includes/install/web/deprecated.md index 2c300a3632e..9e6c5288378 100644 --- a/src/_includes/install/web/deprecated.md +++ b/src/_includes/install/web/deprecated.md @@ -1,2 +1,2 @@ {:.bs-callout-warning} -The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) to install Magento aftere the Web Setup Wizard is removed. +The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) to install Magento after the Web Setup Wizard is removed. From 2baceea58cf629c010894561c767396e9e8e8ef0 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 17:07:17 -0500 Subject: [PATCH 6/8] Added upgrade to messaging per PM feedback --- src/_includes/install/web/deprecated.md | 2 +- src/_includes/layout/page-header.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_includes/install/web/deprecated.md b/src/_includes/install/web/deprecated.md index 9e6c5288378..f345ff49502 100644 --- a/src/_includes/install/web/deprecated.md +++ b/src/_includes/install/web/deprecated.md @@ -1,2 +1,2 @@ {:.bs-callout-warning} -The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the [command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) to install Magento after the Web Setup Wizard is removed. +The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to [install]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) or [upgrade]({{ site.baseurl }}/guides/v2.3/comp-mgr/cli/cli-upgrade.html) Magento after the Web Setup Wizard is removed. diff --git a/src/_includes/layout/page-header.html b/src/_includes/layout/page-header.html index 0a22a96f44a..00a0a4d1f34 100644 --- a/src/_includes/layout/page-header.html +++ b/src/_includes/layout/page-header.html @@ -3,7 +3,7 @@ {% if page.url contains "guides/v2.3/install-gde/install/web/" %}
- The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to install Magento after the Web Setup Wizard is removed. + The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to install or upgrade Magento after the Web Setup Wizard is removed.
{% endif %} From c079fc8d4b45f839ddaaec4cd480dea229a54e13 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 21:24:10 -0500 Subject: [PATCH 7/8] Fix template --- src/_includes/layout/page-header.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_includes/layout/page-header.html b/src/_includes/layout/page-header.html index 00a0a4d1f34..aaeaad448f4 100644 --- a/src/_includes/layout/page-header.html +++ b/src/_includes/layout/page-header.html @@ -1,7 +1,7 @@
- {% if page.url contains "guides/v2.3/install-gde/install/web/" %} + {% if page.url contains "guides/v2.3/install-gde/install/web/" or page.url contains "guides/v2.3/comp-mgr/upgrader/" %}
The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to install or upgrade Magento after the Web Setup Wizard is removed.
From 73352ce12d4876ee6e1e92c8ab6c6d0c71599ed2 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 13 May 2020 21:27:45 -0500 Subject: [PATCH 8/8] Clarified deprecation message --- src/_includes/install/web/deprecated.md | 2 +- src/_includes/layout/page-header.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/_includes/install/web/deprecated.md b/src/_includes/install/web/deprecated.md index f345ff49502..ce919dc3bcb 100644 --- a/src/_includes/install/web/deprecated.md +++ b/src/_includes/install/web/deprecated.md @@ -1,2 +1,2 @@ {:.bs-callout-warning} -The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to [install]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) or [upgrade]({{ site.baseurl }}/guides/v2.3/comp-mgr/cli/cli-upgrade.html) Magento after the Web Setup Wizard is removed. +The Web Setup Wizard is being deprecated in Magento 2.3.6 and will be removed in Magento 2.4.0. After it is removed, you must use the command line to [install]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html) or [upgrade]({{ site.baseurl }}/guides/v2.3/comp-mgr/cli/cli-upgrade.html) Magento. diff --git a/src/_includes/layout/page-header.html b/src/_includes/layout/page-header.html index aaeaad448f4..a4652258cd5 100644 --- a/src/_includes/layout/page-header.html +++ b/src/_includes/layout/page-header.html @@ -3,7 +3,7 @@ {% if page.url contains "guides/v2.3/install-gde/install/web/" or page.url contains "guides/v2.3/comp-mgr/upgrader/" %}
- The Web Setup Wizard has been deprecated and is no longer supported. It will be removed in Magento 2.4.0. You must use the command line to install or upgrade Magento after the Web Setup Wizard is removed. + The Web Setup Wizard is being deprecated in Magento 2.3.6 and will be removed in Magento 2.4.0. After it is removed, you must use the command line to install or upgrade Magento.
{% endif %}