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

Commit 6aa6f62

Browse files
committed
Merge branch 'custom-layout-result-improvement' of https://github.com/chandru-199/devdocs into custom-layout-result-improvement
2 parents f2a784d + e6606c5 commit 6aa6f62

File tree

21 files changed

+247
-150
lines changed

21 files changed

+247
-150
lines changed

src/_includes/graphql/customer-address-input.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,15 @@ Attribute | Data Type | Description
99
`country_code` | String | The customer's country
1010
`country_id` | String | Deprecated. Use `country_code` instead. The customer's country
1111
`custom_attributes` | [CustomerAddressAttributeInput](#customerAddressAttributeInput) | Deprecated. Not applicable for GraphQL
12-
`customer_id` | Int | The customer ID
1312
`default_billing` | Boolean | Indicates whether the address is the default billing address
1413
`default_shipping` | Boolean | Indicates whether the address is the default shipping address
15-
`extension_attributes` | [CustomerAddressAttribute](#customerAddressAttributeInput) | Address extension attributes
1614
`fax` | String | The fax number
1715
`firstname` | String | The first name of the person associated with the shipping/billing address
18-
`id` | Int | The ID assigned to the address object
1916
`lastname` | String | The family name of the person associated with the shipping/billing address
2017
`middlename` | String | The middle name of the person associated with the shipping/billing address
2118
`postcode` | String | The customer's ZIP or postal code
2219
`prefix` | String | An honorific, such as Dr., Mr., or Mrs.
2320
`region` | [CustomerAddressRegionInput](#customerAddressRegionInput) | An object that defines the customer's state or province
24-
`region_id` | Int | Deprecated. Use `region` instead. A number that uniquely identifies the state, province, or other area
2521
`street` | [String] | An array of strings that define the street number and name
2622
`suffix` | String | A value such as Sr., Jr., or III
2723
`telephone` | String | The telephone number
@@ -44,4 +40,4 @@ Attribute | Data Type | Description
4440
--- | --- | ---
4541
`region` | String | The state or province name
4642
`region_code` | String | The address region code
47-
`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region
43+
`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region

src/_includes/graphql/customer-address-output.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Attribute | Data Type | Description
1111
`country_code` | CountryCodeEnum | The customer's country
1212
`country_id` | String | Deprecated. Use `country_code` instead. The customer's country
1313
`custom_attributes` | [CustomerAddressAttribute](#customerAddressAttributeOutput) | Deprecated. Not applicable for GraphQL
14-
`customer_id` | Int | The customer ID
14+
`customer_id` | Int | Deprecated. This attribute is not applicable for GraphQL. The ID assigned to the customer
1515
`default_billing` | Boolean | Indicates whether the address is the default billing address
1616
`default_shipping` | Boolean | Indicates whether the address is the default shipping address
1717
`extension_attributes` | [CustomerAddressAttribute](#customerAddressAttributeOutput) | Address extension attributes
@@ -46,4 +46,4 @@ Attribute | Data Type | Description
4646
--- | --- | ---
4747
`region` | String | The state or province name
4848
`region_code` | String | The address region code
49-
`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region
49+
`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region

src/cloud/before/before-workspace-magento-prereqs.md

Lines changed: 2 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -172,48 +172,9 @@ To set `auto_increment_increment` to 3:
172172
service mysqld restart
173173
```
174174

175-
## Magento Cloud CLI (local) {#cloud-ssh-cli-cli-install}
175+
## Magento Cloud CLI {#cloud-ssh-cli-cli-install}
176176

177-
The Magento Cloud command-line interface (CLI) tool helps you manage your projects and code branches on {{site.data.var.ece}}. For a list of available commands, see [Common Magento CLI commands]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html).
178-
179-
These instructions discuss installation using commands for a Unix environment. For Windows, we recommend using [Cygwin](https://www.cygwin.com/) or Git Bash.
180-
181-
{:.procedure}
182-
To install the Magento Cloud CLI:
183-
184-
1. Log in to your local development machine or switch to the [Magento file system owner]({{ site.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
185-
186-
1. Change to a directory to which the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner) has write access, such as the home directory.
187-
188-
1. Enter the following command:
189-
190-
```bash
191-
curl -sS https://accounts.magento.cloud/cli/installer | php
192-
```
193-
194-
1. After the CLI downloads, an operating system-specific command displays.
195-
196-
For example, on Ubuntu and CentOS, the command is similar to:
197-
198-
```bash
199-
source $HOME/.bashrc
200-
```
201-
202-
For more information about the user shell profile, see [.bash_profile vs .bashrc](https://apple.stackexchange.com/questions/51036/what-is-the-difference-between-bash-profile-and-bashrc)
203-
204-
You can also add the `$HOME/.magento-cloud/bin` to the Magento user's `PATH`:
205-
206-
```bash
207-
export PATH=$PATH:$HOME/.magento-cloud/bin
208-
```
209-
210-
Consult operating system documentation for details.
211-
212-
1. Verify the `magento-cloud` command is in your path by entering the following command:
213-
214-
```bash
215-
magento-cloud list
216-
```
177+
To install the `magento-cloud` CLI , see the [Magento Cloud CLI reference]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html).
217178

218179
## Additional requirements for Magento Commerce {#commerce}
219180

src/cloud/env/environments-start.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,9 @@ After you install the Magento Cloud CLI and set up SSH keys for remote access to
1313

1414
To manage the branches and environments with the Project Web Interface, see [Manage branches with the Project Web Interface]({{ site.baseurl }}/cloud/project/project-webint-branch.html).
1515

16-
## Common Magento Cloud CLI commands {#env-start-comm}
16+
## Use Magento Cloud CLI commands {#env-start-comm}
1717

18-
Magento Cloud CLI commands are very similar to Git commands. You can use them to connect to your {{site.data.var.ece}} project and manage your {{site.data.var.ece}} environments. Although you can run the commands from any directory, we recommend that you run them from a project directory. When run from a project directory, you can omit the `-p <project-ID>` parameter.
19-
20-
The following list of commonly used Magento Cloud CLI commands includes required options only. Use the ``--help``
21-
option with any command to get more detailed information.
22-
23-
Command | Description
24-
--- | ---
25-
`git commit --allow-empty -m "redeploy" && git push <branch-name>` | Push an empty commit to force a redeployment. Some actions, such as adding a user, do not result in deployment.
26-
`magento-cloud login` | Log in to the project.
27-
`magento-cloud project:get <project-ID> <directory> -e <environment-ID>` | Clone a project to a directory. To clone the `master` environment, omit `-e <environment-ID>`.
28-
`magento-cloud environment:list -p <project-ID>` | List the environments in the current project.
29-
`magento-cloud environment:branch <name> <parent-branch>` | Create a new branch with a name and an ID. This information corresponds to the environment.
30-
`magento-cloud environment:checkout <environment-ID>` | Check out an existing environment.
31-
`magento-cloud environment:merge -p <project-ID> -e <environment ID>` | Merge changes in this environment with its parent.
32-
`magento-cloud environment:synchronize -p <project-ID> -e <environment-ID> {code|data}` | Synchronize (`git pull`) code and data from the parent to this environment.
33-
`magento-cloud variable:list` | List variables in this environment.
34-
`magento-cloud variable:set <name> <value>` | Set a value for an environment variable.
35-
36-
For a full list of commands, see the [Magento Cloud CLI reference]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html).
37-
38-
{:.bs-callout-info}
39-
The environment _name_ is different from the environment _ID_ only if you use spaces or capital letters in the environment name. An environment ID consists of all lowercase letters, numbers, and allowed symbols. Capital letters in an environment name are converted to lowercase in the ID; spaces in an environment name are converted to dashes. An environment name _cannot_ include characters reserved for your Linux shell or for regular expressions. Forbidden characters include curly braces (`{ }`), parentheses, asterisk (`*`), angle brackets (`< >`), ampersand (`&`), percent (`%`), and other characters.
18+
Magento Cloud CLI commands are very similar to Git commands. You can use them to connect to your {{site.data.var.ece}} project and manage your {{site.data.var.ece}} environments. Although you can run the commands from any directory, we recommend that you run them from a project directory. When run from a project directory, you can omit the `-p <project-ID>` parameter. See the [Magento Cloud CLI reference]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html).
4019

4120
## Get started creating branches {#getstarted}
4221

src/cloud/project/project-conf-files_magento-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Use the following properties to build your application configuration file. The `
2020

2121
The name is used in the [`routes.yaml`]({{ site.baseurl }}/cloud/project/project-conf-files_routes.html) file to define the HTTP upstream (by default, `php:http`). For example, if the value of `name` is `app`, you must use `app:http` in the upstream field. You can also use this name in multi-application relationships.
2222

23-
{:.bs-callout-info}
24-
Do not change the name of an application after it has been deployed.
23+
{:.bs-callout-warning}
24+
Do not change the name of an application after it has been deployed. Doing so will result in data loss.
2525

2626
### `type` and `build`
2727

src/cloud/project/project-patch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To apply {{site.data.var.ece}} patches manually:
3636
1. From the project root, apply the patches.
3737

3838
```bash
39-
php ./vendor/bin/ece-patches apply
39+
php ./vendor/bin/ece-tools patch
4040
```
4141

4242
1. Clear the Magento cache.
@@ -83,10 +83,10 @@ To use magento-cloud-patches as a stand-alone package:
8383
1. From the project root, apply the patches.
8484

8585
```php
86-
php ./vendor/bin/ece-patches apply
86+
php ./vendor/bin/ece-tools patch
8787
```
8888

89-
This command applies Magento patches and any custom patches found in the `m2/hotfixes` directory.
89+
This command applies Magento patches and any custom patches found in the `/m2-hotfixes` directory.
9090

9191
1. Clear the Magento cache.
9292

src/cloud/reference/cli-ref-topic.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,65 @@ functional_areas:
55
- Cloud
66
---
77

8-
The Magento Cloud CLI is the utility for managing Magento Cloud projects and environments, which implements many features of the Project Web Interface and more. This utility provides an advanced management interface for developers, DevOps and system administrators, for doing routines and automation tasks. You can install and use this utility for all {{site.data.var.ece}} Starter and Pro Integration environments. You cannot use these commands for the Pro Staging and Production environments which aren't listed in the cloud UI.
8+
The Magento Cloud CLI is the utility for managing Magento Cloud projects and environments, which implements many features of the Project Web Interface and more. This utility provides an advanced management interface for developers and system administrators to perform routines and automation tasks. You can install and use this utility for all {{site.data.var.ece}} Starter and Pro Integration environments.
99

10-
You can install the Magento Cloud CLI when setting up your local environment for development:
10+
{:.procedure}
11+
To install the Magento Cloud CLI:
1112

12-
* [Install Magento prerequisites]({{ site.baseurl }}/cloud/before/before-workspace-magento-prereqs.html)
13-
* [Enable SSH keys]({{ site.baseurl }}/cloud/before/before-workspace-ssh.html)
13+
1. On your local workstation, change to a directory where you plan to clone the cloud projects and where the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner) has _write_ access.
1414

15-
## Common commands
15+
1. Install the `magento-cloud` CLI.
1616

17-
The following lists the available `magento-cloud` CLI commands:
17+
```bash
18+
curl -sS https://accounts.magento.cloud/cli/installer | php
19+
```
1820

19-
```bash
20-
magento-cloud list
21-
```
21+
1. Add `magento-cloud` CLI to the bash profile.
22+
23+
```bash
24+
export PATH=$PATH:$HOME/.magento-cloud/bin
25+
```
26+
27+
Consult operating system documentation for details.
28+
29+
1. Reload the updated bash profile.
30+
31+
```bash
32+
. ~/.bash_profile
33+
```
34+
35+
1. To initiate the CLI, call `magento-cloud` and enter your Cloud account credentials when prompted.
36+
37+
```bash
38+
magento-cloud
39+
```
40+
41+
```terminal
42+
Welcome to Magento Cloud!
43+
Please log in using your Magento Cloud account.
44+
Your email address or username:
45+
```
2246

23-
{:.bs-callout-tip}
24-
You can also find information about `magento-cloud` CLI commands in the [Magento command-line tools reference](https://devdocs.magento.com/guides/v2.3/reference/cli/magento.html).
47+
1. Verify the `magento-cloud` command is in your path. The following example lists the available commands.
48+
49+
```bash
50+
magento-cloud list
51+
```
52+
53+
## Common commands
2554

2655
Magento designed these commands to manage Cloud Integration environments. It is a best practice to run the Magento Cloud CLI from a project directory, because you can omit the `-p <project ID>` parameter.
2756

28-
Action | Command
29-
------ | --------
30-
Log in to a project | `magento-cloud login`
31-
Clone a project to a directory | `magento-cloud project:get <PROJECT_ID> <DIRECTORY> -e <ENVIRONMENT_ID>`<br>**Note**: If you want to clone the `master` environment, omit the `-e <ENVIRONMENT_ID>` parameter.
57+
The following list of commonly used Magento Cloud CLI commands includes required options only. You can use the `--help` option with any command to see more information.
58+
59+
Command | Description
60+
------- | -----------
61+
`magento-cloud login` | Log in to the project.
62+
`magento-cloud list` | List the environments in the current project.
63+
`magento-cloud environment:checkout <environment-ID>` | Check out an existing environment.
64+
`magento-cloud environment:merge -e <environment-ID>` | Merge changes in this environment with its parent.
65+
`magento-cloud variables` | List variables in this environment.
66+
`magento-cloud ssh` | Use SSH to connect to the remote environment.
3267

3368
## Environment commands
3469

@@ -58,6 +93,11 @@ Trigger a redeployment without using a push. You must verify and confirm the env
5893

5994
```bash
6095
magento-cloud environment:redeploy
96+
```
97+
98+
Sample response:
99+
100+
```terminal
61101
Are you sure you want to redeploy the environment <environment_name>? [Y/n]
62102
```
63103

@@ -117,7 +157,7 @@ Help:
117157

118158
## Update Magento Cloud CLI
119159

120-
The Magento Cloud CLI checks for available updates upon login, but you can also check for updates using the `self:update` command. If there is an update available, follow the instructions and enter `Y` for _yes_ to update the CLI.
160+
The Magento Cloud CLI checks for available updates when you log in, but you can check for updates using the `self:update` command. If there is an update available, follow the instructions to update the CLI.
121161

122162
If your Magento Cloud CLI is up to date, you see the following response:
123163

Loading

src/guides/v2.3/config-guide/prod/config-reference-most.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,6 @@ Product Listing Sort by | `catalog/frontend/default_sort_by` | <!-- ![Not EE-onl
174174
Allow All Products per Page | `catalog/frontend/list_allow_all` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
175175
Use Flat Catalog Category | `catalog/frontend/flat_catalog_category` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
176176
Use Flat Catalog Product | `catalog/frontend/flat_catalog_product` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
177-
Allow Dynamic Media URLs in Products and Categories | `catalog/frontend/parse_url_directives` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
178177
Swatches per Product | `catalog/frontend/swatches_per_product` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
179178
Allow Guests to Write Reviews | `catalog/review/allow_guest` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |
180179
Allow Alert When Product Price Changes | `catalog/productalert/allow_price` | <!-- ![Not EE-only]({{ site.baseurl }}/common/images/red-x.png) --> |

src/guides/v2.3/ext-best-practices/extension-coding/example-module-adminpage.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,3 +328,7 @@ Now that the module is code-complete, run the following commands to install it:
328328
Once the module installation has completed, the link to the **Hello World** page should appear in the **Greetings** section under **Content** in the left navigation in the admin area. Clicking this link will take you to a page that looks like the one pictured below.
329329

330330
![Hello World Page]({{ site.baseurl }}/common/images/ext-best-practices/hello-world-page.png)
331+
332+
## Related topics
333+
334+
* [Create an ACL rule]({{ page.baseurl }}/ext-best-practices/tutorials/create-access-control-list-rule.html)

0 commit comments

Comments
 (0)