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

Commit 95dba9c

Browse files
authored
Merge pull request #7685 from magento/small-changes
Small changes
2 parents 120795f + 446a180 commit 95dba9c

File tree

16 files changed

+30
-42
lines changed

16 files changed

+30
-42
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ The following guidelines may answer most of your questions and help you get star
7272
- Review your work for basic typos, formatting errors, or ambiguous sentences before opening a pull request.
7373
- Revise pull requests according to review feedback. We will close pull requests that require an inordinate amount of time to review and process (especially for minor changes) if you fail to make revisions according to review feedback.
7474
- Do not directly contact DevDocs team members or maintainers on Slack to review your pull request unless it has been open for more than five days. We have a process and queue for pull requests that everyone must follow.
75+
- Get recognized on the DevDocs web site for writing new topics! Add your name and a link to your company website or GitHub profile to the file metadata so that we can display it on the page. See [Edit metadata](#edit-metadata).
76+
- We no longer recognize individual community members who contribute features to the Magento 2 codebase in the corresponding feature topic(s) on the DevDocs website. Magento recognizes these contributions in more appropriate channels (for example, the [Magento DevBlog](https://community.magento.com/t5/Magento-DevBlog/bg-p/devblog)).
7577

7678
## Tips for writing content
7779

@@ -108,8 +110,10 @@ The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadat
108110
```yaml
109111

110112
---
111-
group: install2
112-
title: Continue with your installation
113+
group:
114+
title:
115+
contributor_name:
116+
contributor_link:
113117
---
114118
```
115119

@@ -119,6 +123,8 @@ title: Continue with your installation
119123
| ------------- | ---------- |
120124
| `group` | Defines the topic's guide or section. Use the table of contents `.yml` file name. This loads your left-side navigation. We will help during the PR process to add new files to the `.yml` file. |
121125
| `title` | Sets the title of the page in the HTML metadata and the main title on the page. |
126+
| `contributor_name` | Sets the name of the contributor who wrote the topic and displays it on the page. |
127+
| `contributor_link` | Creates a link to the contributor's GitHub profile or company website. |
122128

123129
## Report an issue
124130

src/cloud/docker/docker-development-debug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you use Microsoft Windows, take the following steps before continuing:
3838
volumes:
3939
- 'mymagento-magento-sync:/app:nocopy'
4040
environment:
41-
- 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap socketssysvmsg sysvsem sysvshm opcache zip redis xsl sodium'
41+
- 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip redis xsl sodium'
4242
networks:
4343
magento:
4444
aliases:

src/cloud/project/new-relic.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,8 @@ We recommend reviewing tracked data:
205205

206206
All collected data details the time spent on an action transmitting data, queries, or _Redis_ data. If queries cause issues, New Relic provides information to track and respond to those issues.
207207

208+
For details on using this data to troubleshoot Magento performance issues, see [Troubleshoot performance using New Relic][] in the _Magento Help Center_.
209+
208210
{:.bs-callout-info}
209211
You can learn more about using the New Relic APM and Infrastructure agents to collect and analyze application data from the [New Relic APM] and [New Relic Infrastructure][New Relic infrastructure] documentation.
210212

@@ -364,6 +366,7 @@ See [Alerts concepts and workflow] in the New Relic documentation for more detai
364366
[New Relic query syntax for logs]: https://docs.newrelic.com/docs/logs/new-relic-logs/ui-data/query-syntax-logs
365367
[New Relic reporting]: https://docs.magento.com/m2/ce/user_guide/configuration/general/new-relic-reporting.html
366368
[prerequisite steps]: https://docs.newrelic.com/docs/alerts/new-relic-alerts/managing-notification-channels/notification-channels-control-where-send-alerts#channel-types
369+
[Troubleshoot performance using New Relic]: https://support.magento.com/hc/en-us/articles/360042149832#low_user_satisfaction
367370
[reset the New Relic password]: https://rpm.newrelic.com/forgot_password
368371
[Update the account owner]: https://docs.newrelic.com/docs/accounts/accounts/roles-permissions/change-account-owner
369372
[Update policies or conditions]: https://docs.newrelic.com/docs/alerts/new-relic-alerts/configuring-alert-policies/update-or-disable-policies-conditions

src/cloud/project/project-patch.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ When you deploy changes to the remote environment, `{{site.data.var.ct}}` uses `
2323
1. Apply required patches from Magento included in the `{{site.data.var.mcp-package}}` package.
2424
1. Apply optional and custom patches in the `/m2-hotfixes` directory in alphabetical order by patch name.
2525

26-
Also, you can apply patches manually in your local environment.
26+
{:.bs-callout-info}
27+
When you update `{{site.data.var.ct}}` or the `{{site.data.var.mcp-prod}}` package, the latest required patches are applied automatically the next time you deploy your project. You cannot skip [required patches](https://github.com/magento/magento-cloud-patches/tree/develop/patches) during the deployment process.
28+
29+
You can also apply patches manually.
2730

2831
{:.bs-callout-info}
2932
All patch file names must end with the `.patch` extension.

src/guides/v2.3/config-guide/config/config-create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,4 @@ Related topics
131131

132132
* [Module configuration files]({{ page.baseurl }}/config-guide/config/config-php.html)
133133
* [Configuration file merge]({{ page.baseurl }}/config-guide/config/config-files.html#config-files-load-merge-merge)
134-
* [Magento's deployment configuration]({{ page.baseurl }}/config-guide/config/config-php.html)
134+
* [Magento's deployment configuration]({{ page.baseurl }}/config-guide/config/config-files.html)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Example of a theme `composer.json` file:
9999
"sort-packages": true
100100
},
101101
"require": {
102-
"php": "~7.1.3||~7.2.0",
102+
"php": "~7.2.0||~7.3.0",
103103
"magento/framework": "*",
104104
"magento/theme-frontend-blank": "*"
105105
},

src/guides/v2.3/get-started/create-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ To develop a module, you must:
9292
"name": "Vendor1_Module1",
9393
"description": "create integration from config",
9494
"require": {
95-
"php": "~7.1.3|~7.2.0|~7.3.0",
95+
"php": "~7.2.0|~7.3.0",
9696
"magento/framework": "2.0.0",
9797
"magento/module-integration": "2.0.0"
9898
},

src/guides/v2.3/javascript-dev-guide/bk-javascript-dev-guide.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ landing-page: JavaScript Developer Guide
88

99
By default, the Magento application uses the [RequireJS file and module loader] to optimize the time of loading pages with included JavaScript files, and to manage dependencies of JavaScript resources.
1010

11-
You can follow the same approach when customizing Magento JavaScript, or [disable all the default scripts and their load by RequireJS].
12-
1311
For information about how JS resources are located and configured, see the [JavaScript resources] topic in the Configuration Guide.
1412

1513
## What's in this guide {#js_contents}
@@ -40,7 +38,6 @@ JavaScript automatic testing is described in a separate [JavaScript unit testing
4038
[jQuery Widget]: https://jqueryui.com/widget/
4139

4240
[RequireJS file and module loader]: http://requirejs.org/
43-
[disable all the default scripts and their load by RequireJS]: {{page.baseurl}}/javascript-dev-guide/javascript/custom_js.html#disable_default_js
4441
[JavaScript resources]: {{page.baseurl}}/javascript-dev-guide/javascript/js-resources.html
4542

4643
[JavaScript initialization]: {{page.baseurl}}/javascript-dev-guide/javascript/js_init.html

src/guides/v2.3/javascript-dev-guide/javascript/custom_js.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -135,23 +135,7 @@ define([
135135
});
136136
```
137137

138-
For information about initializing your custom JS component in a `.phtml` template, see the [JavaScript initialization] topic.
139-
140-
## Disable default Magento JS {#disable_default_js}
141-
142-
To disable the auto-loading of default Magento JS components and widget initialization:
143-
144-
1. Create a `requirejs-config.js` file with the following content:
145-
146-
```javascript
147-
var config = { deps: [ ] };
148-
```
149-
150-
1. Put the `requirejs-config.js` file in one of the following
151-
locations:
152-
153-
- Your custom theme files: `<theme_dir>`
154-
- Your custom module files: `<module_dir>/view/frontend`
138+
For information about initializing your custom JS component in a `.phtml` template, see the [JavaScript initialization]({{ page.baseurl }}/javascript-dev-guide/javascript/js_init.html) topic.
155139

156140
If you need to enable the loading of default Magento JS components and widget initialization on a certain stage, add the following code in your JS script:
157141

src/guides/v2.3/javascript-dev-guide/javascript/js_overview.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ title: JavaScript
66

77
By default, the Magento application uses the [RequireJS file and module loader] to optimize the time of loading pages with included JavaScript files, and to manage dependencies of JavaScript resources.
88

9-
You can follow the same approach when customizing Magento JavaScript, or [disable all the default scripts and their load by RequireJS].
10-
119
For information about how JS resources are located and configured, see [Configure JavaScript].
1210

1311
## What's in this chapter {#js_contents}
@@ -30,7 +28,6 @@ Topics of this chapter describe the following:
3028
| *jQuery widget* | Custom widget created using jQuery UI Widget Factory and decorated as AMD module. Many Magento JS components are jQuery widget. |
3129

3230
[RequireJS file and module loader]: http://requirejs.org/
33-
[disable all the default scripts and their load by RequireJS]: {{page.baseurl}}/javascript-dev-guide/javascript/custom_js.html#disable_default_js
3431
[Configure JavaScript]: {{page.baseurl}}/javascript-dev-guide/javascript/js-resources.html
3532
[AMD module]: http://requirejs.org/docs/whyamd.html#amd
3633
[app/code/Magento/Ui/view]: {{ site.mage2bloburl }}/{{page.guide_version}}/app/code/Magento/Ui/view

0 commit comments

Comments
 (0)