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

Commit aa98f8e

Browse files
authored
Merge branch 'master' into dobooth-password
2 parents c9bdcc9 + 314b43d commit aa98f8e

File tree

424 files changed

+10428
-9870
lines changed

Some content is hidden

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

424 files changed

+10428
-9870
lines changed

_checks/styles/style-rules-prod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ exclude_rule 'MD005'
66
exclude_rule 'MD006'
77
exclude_rule 'MD007'
88
rule 'MD009'
9-
exclude_rule 'MD010'
9+
rule 'MD010'
1010
exclude_rule 'MD011'
1111
rule 'MD012'
1212
exclude_rule 'MD013'

_data/whats-new.yml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,33 @@ description: |
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 24 09:26:19 2019
7+
updated: Tue Oct 1 20:34:58 2019
88
entries:
9+
- description: Updated the _Cloud Guide_ with instructions for [changing the Fastly API token credential](https://devdocs.magento.com/guides/v2.3/cloud/cdn/cloud-fastly.html#fastly-service-account-and-credentials)
10+
for Staging and Production environments.
11+
versions: 2.x
12+
type: Major update
13+
date: October 1, 2019
14+
link: https://github.com/magento/devdocs/pull/5501
15+
- description: Added instructions for getting connection credentials
16+
to the [Set up RabbitMQ](https://devdocs.magento.com/guides/v2.3/cloud/project/project-conf-files_services-rabbit.html)
17+
topic in the _Cloud Guide_.
18+
versions: 2.2.x, 2.3.x
19+
type: Major update
20+
date: October 1, 2019
21+
link: https://github.com/magento/devdocs/pull/5422
22+
- description: Added the "Disabling an Observer" section to the [Events and Observers](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html)
23+
topic in the _PHP Developer Guide_.
24+
versions: 2.2.x, 2.3.x
25+
type: Major update
26+
date: October 1, 2019
27+
link: https://github.com/magento/devdocs/pull/5489
28+
- description: Added the [RemainingCharacters widget](https://devdocs.magento.com/guides/v2.3/javascript-dev-guide/widgets/widget-remaining-characters.html)
29+
topic to the _Javascript Developer Guide_.
30+
versions: 2.2.x, 2.3.x
31+
type: New topic
32+
date: September 24, 2019
33+
link: https://github.com/magento/devdocs/pull/5452
934
- description: Added example [introspection queries](https://devdocs.magento.com/guides/v2.3/graphql/queries.html)
1035
to the _GraphQL Developer Guide_.
1136
versions: 2.3.x
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Storefront and Admin:
22

3-
* Internet Explorer 11 or later, Microsoft Edge, latest–1
4-
* Firefox latest, latest–1 (any operating system)
5-
* Chrome latest, latest–1 (any operating system)
6-
* Safari latest, latest–1 (Mac OS only)
7-
* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront
8-
* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront
9-
* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront
3+
* Internet Explorer 11 or later, Microsoft Edge, latest–1
4+
* Firefox latest, latest–1 (any operating system)
5+
* Chrome latest, latest–1 (any operating system)
6+
* Safari latest, latest–1 (Mac OS only)
7+
* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront
8+
* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront
9+
* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront
1010

1111
Here, _latest–1_ means one major version earlier than the latest released version.

_includes/cloud/cli-get-started.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11

2-
1. Log in to your local development system, or switch to, the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
3-
2. Change to a directory to which the Magento file system owner has write access.
4-
2. Enter the following command in a terminal to log in to your project:
2+
1. Log in to your local development system, or switch to, the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
3+
1. Change to a directory to which the Magento file system owner has write access.
4+
1. Enter the following command in a terminal to log in to your project:
55

66
```bash
77
magento-cloud login
88
```
99

10-
3. List your projects. With the project ID, you can complete additional commands.
10+
1. List your projects. With the project ID, you can complete additional commands.
1111

1212
```bash
1313
magento-cloud project:list
1414
```
1515

16-
4. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
16+
1. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
1717

1818
```bash
1919
magento-cloud project:get <project ID>
2020
```
2121

22-
4. Change to a project directory. For example, `cd /var/www/html/magento2`
23-
4. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.
22+
1. Change to a project directory. For example, `cd /var/www/html/magento2`
23+
1. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.
2424

2525
```bash
2626
magento-cloud environment:list
@@ -29,27 +29,27 @@
2929
{: .bs-callout .bs-callout-info}
3030
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not.
3131

32-
5. Fetch origin branches to get the latest code:
32+
1. Fetch origin branches to get the latest code:
3333

3434
```bash
3535
git fetch origin
3636
```
3737

38-
6. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.
38+
1. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.
3939

4040
```bash
4141
magento-cloud environment:checkout <environment ID>
4242
```
4343

4444
To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>`
4545

46-
8. Pull any updated code to your local for the environment ID (which is the Git branch):
46+
1. Pull any updated code to your local for the environment ID (which is the Git branch):
4747

4848
```bash
4949
git pull origin <environment ID>
5050
```
5151

52-
7. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup:
52+
1. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup:
5353

5454
```bash
5555
magento-cloud snapshot:create -e <environment ID>

_includes/cloud/cloud-fastly-manage-vcl-from-admin.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
## Modify the custom VCL snippet
22

3-
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.
3+
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.
44

5-
1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**.
5+
1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**.
66

7-
1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**.
7+
1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**.
88

9-
![Manage custom VCL snippets]
9+
![Manage custom VCL snippets]
1010

11-
1. In the _Action_ column, click the settings icon next to the snippet to edit.
11+
1. In the _Action_ column, click the settings icon next to the snippet to edit.
1212

13-
1. After the page reloads, click **Upload VCL to Fastly** in the *Fastly Configuration* section.
13+
1. After the page reloads, click **Upload VCL to Fastly** in the *Fastly Configuration* section.
1414

15-
1. After the upload completes, refresh the cache according to the notification at the top of the page.
15+
1. After the upload completes, refresh the cache according to the notification at the top of the page.
1616

1717
{: .bs-callout .bs-callout-warning}
1818
The *Custom VCL snippets* UI option shows only the snippets added through the Admin UI. You must use the Fastly API to [manage custom snippets added through the API]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-custom-vcl-snippets-using-the-api).
@@ -21,15 +21,13 @@ The *Custom VCL snippets* UI option shows only the snippets added through the Ad
2121

2222
You can delete custom VCL snippet code from your Fastly configuration by uploading an empty version of the snippet from the Magento Admin UI, or delete it completely using the Fastly API.
2323

24-
- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
24+
- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
2525

26-
- Edit the snippet and delete the **VCL** snippet content.
26+
- Edit the snippet and delete the **VCL** snippet content.
27+
- Save the configuration.
28+
- Upload the VCL to Fastly to apply your changes.
2729

28-
- Save the configuration.
29-
30-
- Upload the VCL to Fastly to apply your changes.
31-
32-
- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation
30+
- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation
3331
to delete the snippet completely, or submit a Magento support ticket to request deletion.
3432

3533
[Manage custom VCL snippets]: {{site.baseurl}}/common/images/cloud/cloud-fastly-manage-snippets.png

_includes/cloud/composer-name.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,25 @@ This section discusses how to get a module's Composer name and its version from
33
{:.procedure}
44
To get the module's Composer name from Magento Marketplace:
55

6-
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component.
7-
2. In the upper right corner, click **&lt;your username>** > **My Account** as the following figure shows.
8-
9-
![Access your Marketplace account]({{ site.baseurl }}/common/images/cloud_marketplace-account.png){:width="650px"}
10-
3. On the My Account page, click **My Purchases** as the following figure shows.
11-
12-
![Marketplace purchase history]({{ site.baseurl }}/common/images/cloud_marketplace-purch-history.png){:width="650px"}
13-
4. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows.
14-
15-
![Technical details shows the module's Composer name]({{ site.baseurl }}/common/images/cloud_marketplace-download-invoice.png){:width="200px"}
16-
5. Click **Copy** to copy the component name to the clipboard.
17-
5. Open a text editor.
18-
6. Paste the module name in the text editor.
19-
6. Append a colon character (`:`) to the component name.
20-
7. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
21-
8. Append the version number to the component name after the colon.
6+
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component.
7+
1. In the upper right corner, click **&lt;your username>** > **My Account** as the following figure shows.
8+
9+
![Access your Marketplace account]({{ site.baseurl }}/common/images/cloud_marketplace-account.png){:width="650px"}
10+
11+
1. On the My Account page, click **My Purchases** as the following figure shows.
12+
13+
![Marketplace purchase history]({{ site.baseurl }}/common/images/cloud_marketplace-purch-history.png){:width="650px"}
14+
15+
1. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows.
16+
17+
![Technical details shows the module's Composer name]({{ site.baseurl }}/common/images/cloud_marketplace-download-invoice.png){:width="200px"}
18+
19+
1. Click **Copy** to copy the component name to the clipboard.
20+
1. Open a text editor.
21+
1. Paste the module name in the text editor.
22+
1. Append a colon character (`:`) to the component name.
23+
1. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
24+
1. Append the version number to the component name after the colon.
2225

2326
A sample follows:
2427

_includes/cloud/enable-ssh.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The SSH keys require the following:
77

88
For more information on SSH keys, see the following:
99

10-
* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
11-
* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows)
12-
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)
10+
* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
11+
* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows)
12+
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)
1313

1414
## Locate an existing SSH key pair {#existing}
1515

@@ -112,23 +112,23 @@ After adding the SSH keys, test the SSH connection to GitHub:
112112
113113
You can add SSH keys to your account in any of the following ways:
114114
115-
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
116-
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
115+
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
116+
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
117117
118118
### Add a key using the CLI {#add-key-cli}
119119
120120
To add an SSH key using the CLI:
121121
122-
1. Open a terminal application on your local.
123-
2. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
122+
1. Open a terminal application on your local.
123+
2. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
124124

125-
3. Log in to your project:
125+
3. Log in to your project:
126126

127127
```bash
128128
magento-cloud login
129129
```
130130

131-
3. Add the key:
131+
3. Add the key:
132132

133133
```bash
134134
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
@@ -143,17 +143,20 @@ You will select and add your SSH public key to each environment in your account.
143143

144144
To add an SSH key using the Project Web Interface:
145145

146-
1. Copy your SSH public key to the clipboard.
146+
1. Copy your SSH public key to the clipboard.
147147

148-
If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them.
149-
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
150-
3. In your selected branch, an icon displays if you do not have an SSH key added.
148+
If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them.
151149

152-
![No SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-install.png)
153-
4. Copy and paste the content of your public SSH key in the screen.
150+
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
151+
3. In your selected branch, an icon displays if you do not have an SSH key added.
154152

155-
![Add SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-add.png)
156-
5. Follow the prompts on your screen to complete the task.
153+
![No SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-install.png)
154+
155+
4. Copy and paste the content of your public SSH key in the screen.
156+
157+
![Add SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-add.png)
158+
159+
5. Follow the prompts on your screen to complete the task.
157160

158161
## Set global Git variables
159162

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
1. Access your account. You can open the email you received from Magento Cloud (accounts@magento.cloud) and click the _Access your project now_ link. Or you can log in to [your {{site.data.var.ee}} account](https://accounts.magento.cloud).
22
2. Click the _This project has no code yet_ link next to the Project name.
33

4-
![Project without code]({{ site.baseurl }}/common/images/cloud_project_empty.png)
4+
![Project without code]({{ site.baseurl }}/common/images/cloud_project_empty.png)
55

66
3. Enter a name for the project.
77

8-
![Project name]({{ site.baseurl }}/common/images/cloud_project_name.png)
8+
![Project name]({{ site.baseurl }}/common/images/cloud_project_name.png)
99

1010
4. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
1111

12-
![Create a site using the sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template.png){:width="650px"}
12+
![Create a site using the sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template.png){:width="650px"}
1313

1414
5. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
1515

16-
![Enter your authentication keys]({{ site.baseurl }}/common/images/cloud-project-magento-auth-creds.png){:width="650px"}
16+
![Enter your authentication keys]({{ site.baseurl }}/common/images/cloud-project-magento-auth-creds.png){:width="650px"}
1717

18-
The keys are added to the `auth.json` file in the repository `master` branch, required for all created branches and deployments.
18+
The keys are added to the `auth.json` file in the repository `master` branch, required for all created branches and deployments.
1919

2020
6. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
2121

22-
![Your sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template2.png){:width="650px"}
22+
![Your sample Magento project]({{ site.baseurl }}/common/images/cloud_project_template2.png){:width="650px"}
2323

2424
7. After the project deploys, **Success** displays next to the name of your project.

0 commit comments

Comments
 (0)