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

Commit afd93ba

Browse files
Add deprecation notice about the Web Setup Wizard (#7213)
* Added include for deprecation note * Added deprecation note to all inline references of the web setup wizard * Added banner message for all files in web setup directory * Fixed trailing space and link syntax for cloud include * Update src/_includes/install/web/deprecated.md Co-authored-by: hguthrie <[email protected]> * Added upgrade to messaging per PM feedback * Fix template * Clarified deprecation message Co-authored-by: hguthrie <[email protected]>
1 parent 5185e0c commit afd93ba

20 files changed

+46
-0
lines changed

src/_includes/install/composer-overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ We use [Composer](https://getcomposer.org/){:target="_blank"} to manage Magento
88

99
{:.bs-callout-warning}
1010
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.
11+
12+
{% include install/web/deprecated.md %}

src/_includes/install/file-system-perms-before.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
{% include install/web/deprecated.md %}
6+
57
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.
68

79
{:.bs-callout-info}

src/_includes/install/file-system-perms-before_22.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
{% include install/web/deprecated.md %}
6+
57
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.
68

79
{:.bs-callout-info}

src/_includes/install/flow-diagram.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The diagram shows the following:
1919

2020
1. Install the Magento software using either the Web Setup Wizard or command line.
2121

22+
{% include install/web/deprecated.md %}
23+
2224
For simplicity, only the Web Setup Wizard is shown in the diagram.
2325

2426
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.

src/_includes/install/get-software_zip.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The following table discusses where to get the Magento software. We provide the
55

66
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.
77

8+
{% include install/web/deprecated.md %}
9+
810
Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz`
911

1012
<table>

src/_includes/install/tls-repo.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ failed to open stream: operation failed
2020

2121
### Using the Web Setup Wizard
2222

23+
{% include install/web/deprecated.md %}
24+
2325
Actions like saving your authentication credentials or synchronizing with Magento Marketplace fail with the following error:
2426

2527
![SSL connect error]({{ site.baseurl }}/common/images/install_ssl-connect-error.png)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{:.bs-callout-warning}
2+
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.

src/_includes/layout/page-header.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
<!-- page-header -->
22
<section class="page-intro">
33

4+
{% if page.url contains "guides/v2.3/install-gde/install/web/" or page.url contains "guides/v2.3/comp-mgr/upgrader/" %}
5+
<div class="bs-callout-warning">
6+
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.
7+
</div>
8+
{% endif %}
9+
410
<h1 class="page-title">{{ page.title }}</h1>
511

612
{% if page.subtitle %}

src/cloud/before/before-setup-env-install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ Be ready to install Magento using one of the following options:
108108
- [Install the Magento software using the command line]({{ site.baseurl }}/guides/v2.3/install-gde/install/cli/install-cli.html)
109109
- [Install the Magento software using the Web Setup Wizard]({{ site.baseurl }}/guides/v2.3/install-gde/install/web/install-web.html)
110110

111+
{% include install/web/deprecated.md %}
112+
111113
{:.procedure}
112114
To install Magento using the command line:
113115

src/guides/v2.3/frontend-dev-guide/themes/theme-install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ To install a theme, you need to add its code to your Magento 2 instance code bas
1616
- if a theme is a [composer](https://glossary.magento.com/composer) package, install it using composer.
1717
- if a theme is distributed as an extension, use the **Web Setup Wizard** in [Magento Admin](https://glossary.magento.com/magento-admin).
1818

19+
{% include install/web/deprecated.md %}
20+
1921
The following sections contain more information about each installation flow.
2022

2123
## Prerequisites

src/guides/v2.3/install-gde/bk-install-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Check the availability of exciting new features and releases, and learn how you
2020

2121
Consult the following table for getting started with installing {{site.data.var.ce}} or {{site.data.var.ee}}.
2222

23+
{% include install/web/deprecated.md %}
24+
2325
<table>
2426
<tbody>
2527
<tr>

src/guides/v2.3/install-gde/composer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ For a full description of the CLI install options, refer to [Install the Magento
128128

129129
### Web Setup Wizard
130130

131+
{% include install/web/deprecated.md %}
132+
131133
As an alternative to the CLI, use your browser to navigate to Magento's setup wizard:
132134
133135
```terminal

src/guides/v2.3/install-gde/continue-to-install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Totally lost? Need a helping hand? Try our [installation quick reference (tutori
1919
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:
2020

2121
* 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)
22+
23+
{% include install/web/deprecated.md %}
24+
2225
* [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
2326

2427
## Already installed the Magento software?

src/guides/v2.3/install-gde/install-quick-ref.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ php magento deploy:mode:set developer
117117

118118
### Web Setup Wizard
119119

120+
{% include install/web/deprecated.md %}
121+
120122
{% collapsible Click to view the Web Setup Wizard installation %}
121123

122124
The following example shows how to install using the Web Setup Wizard with the following options:

src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-db-upgr.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Anytime you perform an action that causes the Magento [database schema](https://
2626
Note the following:
2727

2828
* 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.
29+
30+
{% include install/web/deprecated.md %}
31+
2932
* 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
3033

3134
1. Start the upgrade:

src/guides/v2.3/install-gde/install/web/install-web-sample-data-clone.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ functional_areas:
1616
### Install the Magento software
1717

1818
After sample data installation is complete, install the Magento software using the [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html).
19+
20+
{% include install/web/deprecated.md %}

src/guides/v2.3/install-gde/install/web/install-web-sample-data-composer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ functional_areas:
1616
### Install the Magento software
1717

1818
After sample data installation is complete, install the Magento software using the [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html).
19+
20+
{% include install/web/deprecated.md %}

src/guides/v2.3/install-gde/trouble/tshoot_install_depend.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This topic applies to you *only* if you [cloned the Magento 2 GitHub repository]
1717

1818
Errors similar to the following display when you run the Web Setup Wizard:
1919

20+
{% include install/web/deprecated.md %}
21+
2022
```terminal
2123
Magento\Framework\Exception
2224
Command returned non-zero exit code:

src/guides/v2.3/install-gde/tutorials/change-docroot-to-pub.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ This topic describes how to change the Apache [docroot]({{ page.baseurl }}/insta
1919
{:.bs-callout-warning}
2020
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.
2121

22+
{% include install/web/deprecated.md %}
23+
2224
## A note about nginx
2325

2426
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.

src/guides/v2.3/performance-best-practices/hardware.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ If you expect a store's load to change, you can manually increase the number of
2121

2222
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.
2323

24+
{% include install/web/deprecated.md %}
25+
2426
Scenarios and expected PHP memory requirements:
2527

2628
* Webnode serving only storefront pages: 256 MB

0 commit comments

Comments
 (0)