Skip to content

Commit

Permalink
Markdown linting: Fix MD010 (hard tabs) errors and enable rule (magen…
Browse files Browse the repository at this point in the history
…to#5558)

* magento#5245: Hard tabs. Folder: guides/architecture

* magento#5245: Hard tabs. Folder: guides/b2b

* magento#5245: Hard tabs. Folder: guides/coding-standars

* magento#5245: Hard tabs. Folder: guides/сomp-mgr

* magento#5245: Hard tabs. Folder: guides/cloud

* magento#5245: Hard tabs. Folder: guides/config-guide

* magento#5245: Hard tabs. Folder: guides/design-styleguide

* magento#5245: Hard tabs. Folder: guides/extension-dev-guide

* magento#5245: Hard tabs. Folder: guides/frontend-dev-guide

* magento#5245: Hard tabs. Folder: guides/get-started

* magento#5245: Hard tabs. Folder: guides/howdoi

* magento#5245: Hard tabs. Folder: guides/install-gde

* Converted contractions.

* Removed contractions.

* Fixed errors in some includes

* Fixed errors in some install includes

* Fixed errors in remaining install includes

* Fixed all errors config includes

* Fixes all errors in pattern lib guide

* Fixed all errors in migration guide

* Fixed all errors in release notes

* Fixed all errors in rest topics

* Fixed some errors in random places

* Fixed errors in a few topics

* Fixes all errors in graphql guide

* Fixed errors in non-cloud includes

* magento#5245: Hard tabs. Folder: guides/cloud

* magento#5245: Hard tabs. Folder: guides/cloud

* magento#5245: Hard tabs. Folder: guides/cloud

* magento#5245: Hard tabs. Folder: guides/cloud

* Fixed MD040 errors that were hidden by MD010 errors

* Fixed remaining errors and enabled rule

* Fix formatting
  • Loading branch information
jeff-matthews authored Oct 3, 2019
1 parent cab5c33 commit 314b43d
Show file tree
Hide file tree
Showing 423 changed files with 10,402 additions and 9,869 deletions.
2 changes: 1 addition & 1 deletion _checks/styles/style-rules-prod
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ exclude_rule 'MD005'
exclude_rule 'MD006'
exclude_rule 'MD007'
rule 'MD009'
exclude_rule 'MD010'
rule 'MD010'
exclude_rule 'MD011'
rule 'MD012'
exclude_rule 'MD013'
Expand Down
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.
22 changes: 11 additions & 11 deletions _includes/cloud/cli-get-started.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@

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

```bash
magento-cloud login
```

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

```bash
magento-cloud project:list
```

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

```bash
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.
1. Change to a project directory. For example, `cd /var/www/html/magento2`
1. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.

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

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

```bash
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.
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.

```bash
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):
1. Pull any updated code to your local for the environment ID (which is the Git branch):

```bash
git pull origin <environment ID>
```

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

```bash
magento-cloud snapshot:create -e <environment ID>
Expand Down
26 changes: 12 additions & 14 deletions _includes/cloud/cloud-fastly-manage-vcl-from-admin.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
## Modify the custom VCL snippet

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

1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**.
1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**.

1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**.
1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**.

![Manage custom VCL snippets]
![Manage custom VCL snippets]

1. In the _Action_ column, click the settings icon next to the snippet to edit.
1. In the _Action_ column, click the settings icon next to the snippet to edit.

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

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

{: .bs-callout .bs-callout-warning}
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).
Expand All @@ -21,15 +21,13 @@ The *Custom VCL snippets* UI option shows only the snippets added through the Ad

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.

- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
- 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.
- Upload the VCL to Fastly to apply your changes.

- Save the configuration.

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

[Manage custom VCL snippets]: {{site.baseurl}}/common/images/cloud/cloud-fastly-manage-snippets.png
Expand Down
35 changes: 19 additions & 16 deletions _includes/cloud/composer-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,25 @@ This section discusses how to get a module's Composer name and its version from
{:.procedure}
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.

![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.

![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.
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component.
1. 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"}

1. 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"}

1. 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"}

1. Click **Copy** to copy the component name to the clipboard.
1. Open a text editor.
1. Paste the module name in the text editor.
1. Append a colon character (`:`) to the component name.
1. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard.
1. Append the version number to the component name after the colon.

A sample follows:

Expand Down
37 changes: 20 additions & 17 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 Down Expand Up @@ -112,23 +112,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:

```bash
magento-cloud login
```

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

```bash
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
Expand All @@ -143,17 +143,20 @@ 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.

![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.
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.

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

## Set global Git variables

Expand Down
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 ([email protected]) 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

0 comments on commit 314b43d

Please sign in to comment.