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

Commit 3404f5d

Browse files
Merge branch 'master' into 2022-release-schedule
2 parents a7a995e + e9e612c commit 3404f5d

File tree

60 files changed

+556
-33
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+556
-33
lines changed

src/_data/toc/contributor-guide.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ pages:
1818
url: /contributor-guide/pull-request-tests.html
1919
versionless: true
2020

21+
- label: PHPStorm plugin code inspections
22+
url: /contributor-guide/phpstorm-code-inspections.html
23+
versionless: true
24+
2125
- label: Docs Contributions
2226
children:
2327
- label: Contribution Guidelines

src/_data/toc/extension-best-practices.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,28 @@ pages:
3232
- label: Coding FAQ
3333
url: /ext-best-practices/extension-coding/coding-faq.html
3434

35+
- label: PHPStorm plugin
36+
url: /ext-best-practices/phpstorm/introduction.html
37+
children:
38+
39+
- label: Code generation
40+
url: /ext-best-practices/phpstorm/code-generation.html
41+
42+
- label: Code inspection
43+
url: /ext-best-practices/phpstorm/code-inspection.html
44+
45+
- label: Adding code inspections
46+
url: /ext-best-practices/phpstorm/adding-code-inspections.html
47+
48+
- label: New features
49+
url: /ext-best-practices/phpstorm/new-features.html
50+
51+
- label: Issue reporting
52+
url: /ext-best-practices/phpstorm/issue-reporting.html
53+
54+
- label: Run the Upgrade Compatibility Tool
55+
url: /ext-best-practices/phpstorm/uct-run-configuration.html
56+
3557
- label: Storefront
3658
url: /ext-best-practices/storefront/storefront-best-practices.html
3759

src/_data/whats-new.yml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,32 @@ description: This page contains recent changes that we think you'd like to know
44
We exclude from this list proofreading, spelling checks, and all minor updates.
55
link: "/whats-new.html"
66
thread: "/whatsnew-feed.xml"
7-
updated: Tue Sep 7 21:38:19 2021
7+
updated: Mon Sep 13 14:39:26 2021
88
entries:
9+
- description: Updated the [Service versions compatibility table](https://devdocs.magento.com/cloud/project/services.html#service-versions)
10+
in the Cloud guide.
11+
versions: 2.x
12+
type: Technical
13+
date: September 8, 2021
14+
link: https://github.com/magento-commerce/devdocs/pull/2512
15+
merge_commit: f062510d13a0596f8298bac440bf3b3b0eda356d
16+
contributor: hguthrie
17+
membership: true
18+
labels:
19+
- 2.x
20+
- Technical
21+
- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
22+
for the 1.1.2 Quality Patches Tool release.
23+
versions: 2.x
24+
type: Major Update
25+
date: September 7, 2021
26+
link: https://github.com/magento-commerce/devdocs/pull/2516
27+
merge_commit: 28cb71a4e8e700cdb0816db7146d3f705a50e894
28+
contributor: agorbivskyi
29+
membership: true
30+
labels:
31+
- 2.x
32+
- Major Update
933
- description: Added a new [file upload security](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/security/uploads.html)
1034
topic.
1135
versions: 2.3.x, 2.4.x

src/cloud/project/services.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ redirect_from:
1010

1111
The `services.yaml` file defines the services supported and used by {{site.data.var.ece}}, such as MySQL, Redis, and ElasticSearch. You do not need to subscribe to external service providers. This file is in the `.magento` directory of your project.
1212

13-
The deploy script uses the configuration files in the `.magento` directory to provision the environment with the configured services. A service becomes available to your application if it is included in the [`relationships`]({{ site.baseurl }}/cloud/project/magento-app-properties.html#relationships) property of the `.magento.app.yaml` file. The `services.yaml` file contains the _type_ and _disk_ values. Service type defines the service _name_ and _version_. Changing a service configuration causes a deployment to provision the environment with the updated services.
13+
The deploy script uses the configuration files in the `.magento` directory to provision the environment with the configured services. A service becomes available to your application if it is included in the [`relationships`]({{ site.baseurl }}/cloud/project/magento-app-properties.html#relationships) property of the `.magento.app.yaml` file. The `services.yaml` file contains the _type_ and _disk_ values. Service type defines the service _name_ and _version_.
1414

15-
This affects the following environments:
15+
Changing a service configuration causes a deployment to provision the environment with the updated services, which affects the following environments:
1616

1717
- All Starter environments including Production `master`
1818
- Pro Integration environments
@@ -21,7 +21,7 @@ This affects the following environments:
2121

2222
## Default and supported services
2323

24-
We support and deploy the following services:
24+
The cloud infrastructure supports and deploys the following services:
2525

2626
- [`mysql`]({{ site.baseurl }}/cloud/project/services-mysql.html)
2727
- [`redis`]({{ site.baseurl }}/cloud/project/services-redis.html)
@@ -67,7 +67,7 @@ relationships:
6767
redis: "<name>:redis"
6868
```
6969

70-
You can name multiple instances of each service type. For example, we could use multiple Redis instances—one for session and one for cache.
70+
You can name multiple instances of each service type. For example, you could use multiple Redis instances—one for session and one for cache.
7171

7272
```yaml
7373
redis:
@@ -79,8 +79,8 @@ redis2:
7979

8080
Renaming a service in the `services.yaml` file **permanently removes** the following:
8181

82-
- The existing service before creating a new service with the new name you specify.
83-
- All existing data for the service is removed. We strongly recommend you [snapshot your environment]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you change the name of an existing service.
82+
- The existing service before creating a service with the new name you specify.
83+
- All existing data for the service is removed. Adobe strongly recommends that you [snapshot your environment]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you change the name of an existing service.
8484

8585
### `type`
8686

@@ -165,19 +165,19 @@ To verify relationships in remote environments:
165165

166166
{%include cloud/note-cloud-services-compatibility.md%}
167167

168-
The following table lists the services used in {{site.data.var.ece}} and their version compatibility with the [Magento Cloud template](https://github.com/magento/magento-cloud).
168+
The following table lists the services used in {{site.data.var.ece}} and the service version compatibility with the [Magento Cloud template](https://github.com/magento/magento-cloud). The {{site.data.var.ee}} columns show the service versions that are compatible with that latest version for {{site.data.var.ee}}. The **Version Notes** column specifically calls out compatibility differences from latest, and any other relevant service compatibility notes.
169169

170170
{:.error-table}
171-
| Service | {{site.data.var.ee}} 2.4 | {{site.data.var.ee}} 2.3 | {{site.data.var.ee}} 2.2 |
172-
| --------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
173-
| `elasticsearch` | 7.7, 7.9 | **{{site.data.var.ee}} version 2.3.5 and later**— 5.2, 6.5, 6.8, 7.5, 7.7, 7.9<br>**{{site.data.var.ee}} version 2.3.1 to 2.3.4**— 5.2, 6.5<br>**{{site.data.var.ee}} version 2.3.0**— 5.2 | **{{site.data.var.ee}} version 2.2.8 and later**— 5.2, 6.5 <br>**{{site.data.var.ee}} version 2.2.0 to 2.2.7**— 5.2 |
174-
| `mariadb` | 10.2, 10.3, 10.4 | **{{site.data.var.ee}} version 2.3.0 to 2.3.5**–10.1 to 10.2<br> | 10.1 to 10.2 |
175-
| `nginx` | | 1.9 | 1.9 |
176-
| `node` | | 6, 8, 10, 11 | 6, 8, 10, 11 |
177-
| `php` | 7.3, 7.4 | **{{site.data.var.ee}} version 2.3.4 and later**— 7.1, 7.2, 7.3<br>**{{site.data.var.ee}} version 2.3.3**— 7.1, 7.2, 7.3<br>**{{site.data.var.ee}} version 2.3.0 to 2.3.2**— 7.1, 7.2 | **{{site.data.var.ee}} version 2.2.10 and later**— 7.1, 7.2<br>**{{site.data.var.ee}} version 2.2.5 to 2.2.9**— 7.0, 7.1<br>**{{site.data.var.ee}} version 2.2.4 and earlier**— 7.0.2, 7.0.4, ~7.0.6, 7.1<br><br>**Note:** Beginning with {{ site.data.var.ct }} v2002.1.0, you must use PHP version 7.1.3 or later for both 2.2 and 2.3. |
178-
| `rabbitmq` | 3.8 | **{{site.data.var.ee}} version 2.3.5**–3.8<br>**{{site.data.var.ee}} version 2.3.3 - 2.3.4**— 3.7, 3.8<br>**{{site.data.var.ee}} version 2.3.0 to 2.3.3**— 3.7 | 3.5 |
179-
| `redis` | 5.x, 6.x | **{{site.data.var.ee}} version 2.3.1 - 2.3.7**–5.x, 6.x<br>**{{site.data.var.ee}} version 2.3.0**— 3.2 | 3.2, 5.0, 6.x |
180-
| `varnish` | 6.x | **{{site.data.var.ee}} version 2.3.3 to 2.3.5**— 4.0, 5.0, 6.2<br>**{{site.data.var.ee}} version 2.3.0 to 2.3.2**— 4.0, 5.0 | 4.0, 5.0<br>**Note:** On Cloud projects, you must use the [Fastly service]({{site.baseurl}}/cloud/cdn/cloud-fastly.html) for caching. Varnish is available only for local development. |
171+
| Service | {{site.data.var.ee}} 2.4 | {{site.data.var.ee}} 2.3 | {{site.data.var.ee}} 2.2 | Version Notes |
172+
| --------------- | ------------------------ | ------------------------- | -------------------------- | ----------------------------------------- |
173+
| `elasticsearch` | 7.7, 7.9 | 6.8, 7.5, 7.7, 7.9 | 5.2, 6.5 | **Commerce 2.3.1 to 2.3.4**— 5.2, 6.5<br>**Commerce 2.3.0**— 5.2<br>**Commerce 2.2.0 to 2.2.7**— 5.2 |
174+
| `mariadb` | 10.2 to 10.4 | 10.1 to 10.3 | 10.1 to 10.2 | **Commerce 2.3.0 to 2.3.5**— 10.1 to 10.2 |
175+
| `nginx` | 1.9 | 1.9 | 1.9 | |
176+
| `node` | 6, 8, 10, 11 | 6, 8, 10, 11 | 6, 8, 10, 11 | |
177+
| `php` | 7.3, 7.4 | 7.2, 7.3, 7.4 | 7.1, 7.2 | **Note:** Beginning with {{ site.data.var.ct }} v2002.1.0, you must use PHP template version 7.1.3 or later for both 2.2 and 2.3.<br><br>**Commerce 2.3.3**— 7.1, 7.2, 7.3<br>**Commerce 2.3.0 to 2.3.2**— 7.1, 7.2 <br>**Commerce 2.2.5 to 2.2.9**— 7.0, 7.1<br>**Commerce 2.2.4 and earlier**— 7.0.2, 7.0.4, ~7.0.6, 7.1 |
178+
| `rabbitmq` | 3.8 | 3.7, 3.8 | 3.5 | **Commerce 2.3.0 to 2.3.3**— 3.7 |
179+
| `redis` | 5.x, 6.x | 5.x, 6.x | 3.2, 5.0, 6.x | **Commerce 2.3.0**— 3.2 |
180+
| `varnish` | 6.x | 4.0, 5.0, 6.2 | 4.0, 5.0 | **Note:** On Cloud projects, you must use the [Fastly service]({{site.baseurl}}/cloud/cdn/cloud-fastly.html) for caching. Varnish is available only for local development.<br><br>**Commerce 2.3.0 to 2.3.2**— 4.0, 5.0 |
181181

182182
{:.bs-callout-info}
183183
When you set up the Elasticsearch service, check to ensure that you use a version that is compatible with the installed [Elasticsearch PHP](https://github.com/elastic/elasticsearch-php) client. See [Check Elasticsearch software compatibility]({{ site.baseurl }}/cloud/project/services-elastic.html#elasticsearch-software-compatibility).
@@ -195,9 +195,9 @@ To maintain store security, update installed software versions before they reach
195195

196196
You can upgrade the installed service version for compatibility with the {{site.data.var.ee}} version deployed in your Cloud environment.
197197

198-
You cannot downgrade the service version for an installed service directly. However, you can create a new service with the required version. See [Downgrade service version](#downgrade-version).
198+
You cannot downgrade the service version for an installed service directly. However, you can create a service with the required version. See [Downgrade service version](#downgrade-version).
199199

200-
Use the [Service versions](#service-versions) table to check service version compatibility by {{site.data.var.ee}} version. Note that some service versions supported by {{ site.data.var.ee }} are not supported on {{ site.data.var.ece }}.
200+
Use the [Service versions](#service-versions) table to check service version compatibility by {{site.data.var.ee}} version. Some service versions supported by {{ site.data.var.ee }} are not supported on {{ site.data.var.ece }}.
201201

202202
### Upgrade installed service version
203203

@@ -241,7 +241,7 @@ You cannot downgrade an installed service directly. You have two options:
241241

242242
- Rename an existing service with the new version, which removes the existing service and data, and adds a new one.
243243

244-
- Create a new service and save the data from the existing service.
244+
- Create a service and save the data from the existing service.
245245

246246
When you change the service version, you must update the service configuration in the `services.yaml` file, and update the relationships in the `.magento.app.yaml` file.
247247

@@ -251,7 +251,7 @@ To downgrade a service version by renaming an existing service:
251251
1. Rename the existing service in the `.magento/services.yaml` file and change the version.
252252

253253
{:.bs-callout-warning}
254-
Renaming an existing service replaces it and deletes all data. If you need to retain the data, create a new service instead of renaming the existing one.
254+
Renaming an existing service replaces it and deletes all data. If you need to retain the data, create a service instead of renaming the existing one.
255255

256256
For example, to downgrade the MariaDB version for the _mysql_ service from version 10.3 to 10.2, change the existing _service-id_ and _type_ configuration.
257257

5.68 KB
Loading
23.6 KB
Loading
21.8 KB
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)