Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Add deprecation notice about the Web Setup Wizard #7213

Merged
merged 9 commits into from
May 14, 2020
2 changes: 2 additions & 0 deletions src/_includes/install/composer-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
2 changes: 2 additions & 0 deletions src/_includes/install/file-system-perms-before.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 2 additions & 0 deletions src/_includes/install/file-system-perms-before_22.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 2 additions & 0 deletions src/_includes/install/flow-diagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions src/_includes/install/get-software_zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

<table>
Expand Down
2 changes: 2 additions & 0 deletions src/_includes/install/tls-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 2 additions & 0 deletions src/_includes/install/web/deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{:.bs-callout-warning}
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.
6 changes: 6 additions & 0 deletions src/_includes/layout/page-header.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
<!-- page-header -->
<section class="page-intro">

{% if page.url contains "guides/v2.3/install-gde/install/web/" or page.url contains "guides/v2.3/comp-mgr/upgrader/" %}
<div class="bs-callout-warning">
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 <a href="https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli.html">install</a> or <a href="https://devdocs.magento.com/guides/v2.3/comp-mgr/cli/cli-upgrade.html">upgrade</a> Magento.
</div>
{% endif %}

<h1 class="page-title">{{ page.title }}</h1>

{% if page.subtitle %}
Expand Down
2 changes: 2 additions & 0 deletions src/cloud/before/before-setup-env-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions src/guides/v2.3/frontend-dev-guide/themes/theme-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/guides/v2.3/install-gde/bk-install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

<table>
<tbody>
<tr>
Expand Down
2 changes: 2 additions & 0 deletions src/guides/v2.3/install-gde/composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/guides/v2.3/install-gde/continue-to-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
2 changes: 2 additions & 0 deletions src/guides/v2.3/install-gde/install-quick-ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
2 changes: 2 additions & 0 deletions src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions src/guides/v2.3/performance-best-practices/hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down