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

magento/devdocs#5245: Markdown linting: Hard tabs (MD010) #5362

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 7 additions & 7 deletions _includes/browsers/supported-browsers.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Storefront and Admin:

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

Here, _latest–1_ means one major version earlier than the latest released version.
38 changes: 19 additions & 19 deletions _includes/cloud/cli-get-started.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@

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).
2. Change to a directory to which the Magento file system owner has write access.
2. Enter the following command in a terminal to log in to your project:
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).
2. Change to a directory to which the Magento file system owner has write access.
2. Enter the following command in a terminal to log in to your project:

magento-cloud login
3. List your projects. With the project ID, you can complete additional commands.
magento-cloud login
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A step that includes code blocks, images, or step sub-paragraphs should begin at the same position as the first letter of the step sentence. Otherwise, this ordered list loses the order and formatting. You will have to review each file to ensure that replacing the hard tab does not adversely affect the formatting of the topic elements.

3. List your projects. With the project ID, you can complete additional commands.

magento-cloud project:list
4. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
magento-cloud project:list
4. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.

magento-cloud project:get <project ID>
magento-cloud project:get <project ID>

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

magento-cloud environment:list
magento-cloud environment:list

{: .bs-callout .bs-callout-info}
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not.
`magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not.

5. Fetch origin branches to get the latest code:
5. Fetch origin branches to get the latest code:

git fetch origin
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.
git fetch origin
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.

magento-cloud environment:checkout <environment ID>
magento-cloud environment:checkout <environment ID>

To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>`
8. Pull any updated code to your local for the environment ID (which is the Git branch):
To create a new environment, use `magento-cloud environment:branch <environment name> <parent environment ID>`
8. Pull any updated code to your local for the environment ID (which is the Git branch):

git pull origin <environment ID>
git pull origin <environment ID>
7. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup:

magento-cloud snapshot:create -e <environment ID>
6 changes: 3 additions & 3 deletions _includes/cloud/cloud-fastly-manage-vcl-from-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ You can delete custom VCL snippet code from your Fastly configuration by uploadi

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

- Edit the snippet and delete the **VCL** snippet content.
- Edit the snippet and delete the **VCL** snippet content.

- Save the configuration.
- Save the configuration.

- Upload the VCL to Fastly to apply your changes.
- Upload the VCL to Fastly to apply your changes.

- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation
to delete the snippet completely, or submit a Magento support ticket to request deletion.
Expand Down
30 changes: 15 additions & 15 deletions _includes/cloud/composer-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@ This section discusses how to get a module's Composer name and its version from

#### To get the module's Composer name from Magento Marketplace:

1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component.
2. In the upper right corner, click **&lt;your username>** > **My Account** as the following figure shows.
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component.
2. In the upper right corner, click **&lt;your username>** > **My Account** as the following figure shows.

![Access your Marketplace account]({{ site.baseurl }}/common/images/cloud_marketplace-account.png){:width="650px"}
3. On the My Account page, click **My Purchases** as the following figure shows.
![Access your Marketplace account]({{ site.baseurl }}/common/images/cloud_marketplace-account.png){:width="650px"}
3. On the My Account page, click **My Purchases** as the following figure shows.

![Marketplace purchase history]({{ site.baseurl }}/common/images/cloud_marketplace-purch-history.png){:width="650px"}
4. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows.
![Marketplace purchase history]({{ site.baseurl }}/common/images/cloud_marketplace-purch-history.png){:width="650px"}
4. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows.

![Technical details shows the module's Composer name]({{ site.baseurl }}/common/images/cloud_marketplace-download-invoice.png){:width="200px"}
5. Click **Copy** to copy the component name to the clipboard.
5. Open a text editor.
6. Paste the module name in the text editor.
6. Append a colon character (`:`) to the component name.
7. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
8. Append the version number to the component name after the colon.
![Technical details shows the module's Composer name]({{ site.baseurl }}/common/images/cloud_marketplace-download-invoice.png){:width="200px"}
5. Click **Copy** to copy the component name to the clipboard.
5. Open a text editor.
6. Paste the module name in the text editor.
6. Append a colon character (`:`) to the component name.
7. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
8. Append the version number to the component name after the colon.

A sample follows:
A sample follows:

pixlee/magento2:1.0.1
pixlee/magento2:1.0.1
48 changes: 24 additions & 24 deletions _includes/cloud/enable-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ The SSH keys require the following:

For more information on SSH keys, see the following:

* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
* [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)
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)
* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
* [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)
* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen)

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

Expand All @@ -19,11 +19,11 @@ You can quickly verify if you have SSH keys by entering commands using terminal

To check for SSH keys, enter the following command:

ls ~/.ssh
ls ~/.ssh

If you have SSH keys, a directory listing is displayed similar to the following:

id_rsa id_rsa.pub known_hosts
id_rsa id_rsa.pub known_hosts

If you do not have SSH keys, you need to generate the keys for adding to your Magento ECE account and GitHub account. See [Create a new SSH key pair](#ssh-create-new-key-pair).

Expand Down Expand Up @@ -94,7 +94,7 @@ After adding the SSH keys, test the SSH connection to GitHub:

1. In the terminal, enter the following command:

ssh -T git@github.com
ssh -T git@github.com

2. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.

Expand All @@ -104,23 +104,23 @@ After adding the SSH keys, test the SSH connection to GitHub:

You can add SSH keys to your account in any of the following ways:

* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
* Using the [{{site.data.var.ece}} CLI](#add-key-cli)
* Using the [{{site.data.var.ece}} Web Interface](#add-key-web)

### Add a key using the CLI {#add-key-cli}

To add an SSH key using the CLI:

1. Open a terminal application on your local.
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.
1. Open a terminal application on your local.
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.

3. Log in to your project:
3. Log in to your project:

magento-cloud login
magento-cloud login

3. Add the key:
3. Add the key:

magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub

#### Add a key using the Project Web Interface {#add-key-web}

Expand All @@ -131,25 +131,25 @@ You will select and add your SSH public key to each environment in your account.

To add an SSH key using the Project Web Interface:

1. Copy your SSH public key to the clipboard.
1. Copy your SSH public key to the clipboard.

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.
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
3. In your selected branch, an icon displays if you do not have an SSH key added.
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.
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
3. In your selected branch, an icon displays if you do not have an SSH key added.

![No SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-install.png)
4. Copy and paste the content of your public SSH key in the screen.
![No SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-install.png)
4. Copy and paste the content of your public SSH key in the screen.

![Add SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-add.png)
5. Follow the prompts on your screen to complete the task.
![Add SSH key]({{ site.baseurl }}/common/images/cloud_ssh-key-add.png)
5. Follow the prompts on your screen to complete the task.

## Set global Git variables

Set required global Git variables on the machine to commit or push to a Git branch. These variables set Git credentials for accessing your GitHub account.

To set variables, enter the following commands on every workspace:

git config --global user.name "<your name>"
git config --global user.email <your e-mail address>
git config --global user.name "<your name>"
git config --global user.email <your e-mail address>

For more information, see [First-Time Git Setup](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_first_time)
12 changes: 6 additions & 6 deletions _includes/cloud/new-project-from-template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
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).
2. Click the _This project has no code yet_ link next to the Project name.

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

3. Enter a name for the project.

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

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.

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

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

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

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

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

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

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