Fixed errors in coding standards, comp-mgr, contributor

jeff-matthews · jeff-matthews · commit 10023f4076f0 · 2019-10-14T14:41:37.000-05:00
diff --git a/_checks/styles/style-rules-prod b/_checks/styles/style-rules-prod
@@ -22,7 +22,7 @@ rule 'MD025'
 exclude_rule 'MD026'
 exclude_rule 'MD027'
 exclude_rule 'MD028'
-exclude_rule 'MD029'
+rule 'MD029'
 exclude_rule 'MD030'
 exclude_rule 'MD031'
 exclude_rule 'MD032'
diff --git a/guides/v2.2/coding-standards/docblock-standard-general.md b/guides/v2.2/coding-standards/docblock-standard-general.md
@@ -32,7 +32,7 @@ The following is assumed by default:
 The documentation should follow two simple principles:
 
 1. Be as short as possible.
-2. Include all necessary information without duplication.
+1. Include all necessary information without duplication.
 
 ### Short documentation
 
@@ -71,10 +71,11 @@ Below are ways of improving code to help simplify documentation:
 ### Include all the necessary details
 
 1. Identify the details a developer needs to work with your code.
-2. Ignore the implementation details (i.e. private methods/properties and method bodies) and focus on what the public interface signature provides.
+1. Ignore the implementation details (i.e. private methods/properties and method bodies) and focus on what the public interface signature provides.
 
    If possible, improve the interface to provide more information.
-3. Add any remaining information that a developer may need to the DocBlock.
+
+1. Add any remaining information that a developer may need to the DocBlock.
 
 ## Files
 {:#files}
diff --git a/guides/v2.2/coding-standards/technical-vision/webapi.md b/guides/v2.2/coding-standards/technical-vision/webapi.md
@@ -64,7 +64,7 @@ To extend an interface, use [extension attributes]({{ page.baseurl }}/extension-
 
 1. Add a `schema.graphqls` file to the `<ModuleName>GraphQl` module. Magento merges this file with configurations from other modules using the same merge rules as other types of configuration.
 
-2. Write any necessary plugins for existing resolvers related to the query, or create a custom resolver and enable it via override in `schema.graphqls`
+1. Write any necessary plugins for existing resolvers related to the query, or create a custom resolver and enable it via override in `schema.graphqls`
 
 ### Model Consistency Constraints
 
diff --git a/guides/v2.2/comp-mgr/marketplace/marketplace.md b/guides/v2.2/comp-mgr/marketplace/marketplace.md
@@ -21,7 +21,7 @@ If you don't have an account yet:
 
    ![Sign in to Marketplace]({{ site.baseurl }}/common/images/marketplace_sign-in.png){:width="600px"}
 
-2. In the right pane, click **Create an account**.
+1. In the right pane, click **Create an account**.
 
    ![Create a Marketplace account]({{ site.baseurl }}/common/images/marketplace_create-acct.png){:width="300px"}
 
@@ -44,4 +44,3 @@ When you're ready, click **Go to Checkout** and follow the prompts on your scree
 ### Install your new purchases
 
 Use the [Component Manager]({{ page.baseurl }}/comp-mgr/module-man/compman-checklist.html) to install your purchases.
-
diff --git a/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md b/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md
@@ -69,18 +69,18 @@ To upgrade components:
 
    ![Select the version of Magento core components to which to upgrade]({{ site.baseurl }}/common/images/upgr_step1_core-ver.png)
 
-2. For each third-party component:
+1. For each third-party component:
 
-   * If you *do* want to upgrade it, set **Upgrade** to **Yes** and click the version from the **Update Version** list.
+   *  If you *do* want to upgrade it, set **Upgrade** to **Yes** and click the version from the **Update Version** list.
 
       A sample follows.
 
       ![Upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_yes.png)
 
-   * If you *do not* want to upgrade it, set **Upgrade** to **No**.
+   *  If you *do not* want to upgrade it, set **Upgrade** to **No**.
 
       A sample follows.
 
       ![Do not upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_no.png)
 
-3. Click **Next** and continue with [Step 2. Readiness check]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-readiness.html)
+1. Click **Next** and continue with [Step 2. Readiness check]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-readiness.html)
diff --git a/guides/v2.2/contributor-guide/templates/basic_template.md b/guides/v2.2/contributor-guide/templates/basic_template.md
@@ -57,23 +57,23 @@ Lists are useful for organizing and displaying related items. Below are examples
 
 *Output:*
 
-* List Item 1
-* List Item 2
-* List Item 3
+*  List Item 1
+*  List Item 2
+*  List Item 3
 
 **Ordered List:**
 
 ```markdown
 1. First Step
-2. Second Step
-3. Third Step
+1. Second Step
+1. Third Step
 ```
 
 *Output:*
 
 1. First Step
-2. Second Step
-3. Third Step
+1. Second Step
+1. Third Step
 
 ### Images {#images}
 
diff --git a/guides/v2.2/design-styleguide/content-voice-tone/content-voice-tone.md b/guides/v2.2/design-styleguide/content-voice-tone/content-voice-tone.md
@@ -182,7 +182,7 @@ Consistency is critical. For example, wherever content is displayed in [Data Tab
 Take a neutral tone – don’t blame a merchant or in any way indicate that the merchant made a mistake. Use “business casual” and easy-to-understand language. Avoid personal pronouns and technical jargon. Content structure and formatting should follow this order:
 
 1. Tell merchants what went wrong, in specific terms.
-2. Instruct how to fix the problem and continue the current task. If the error can’t be resolved online, try to give merchants an appropriate offline contact option and a timeframe when they should try again.
+1. Instruct how to fix the problem and continue the current task. If the error can’t be resolved online, try to give merchants an appropriate offline contact option and a timeframe when they should try again.
 
 *Example:*
 
diff --git a/guides/v2.2/design-styleguide/errors-and-messages/errors-and-messages.md b/guides/v2.2/design-styleguide/errors-and-messages/errors-and-messages.md
@@ -8,27 +8,27 @@ menu_node:
 ---
 Magento uses different types of dynamic messaging to alert users when:
 
-* An error has occurred and blocks them in completing a task
+*  An error has occurred and blocks them in completing a task
 
-* Users need to know important information before continuing a task
+*  Users need to know important information before continuing a task
 
 ## Types of Errors and Messages
 
-* **Information information.** This messaging is not an error. It's used when a person can continue with the task but needs to be alerted regarding information critical to completing a task.
+*  **Information information.** This messaging is not an error. It's used when a person can continue with the task but needs to be alerted regarding information critical to completing a task.
 
-* **Recoverable error.** Used when a person is blocked and can only continue by taking an action to fix the problem.
+*  **Recoverable error.** Used when a person is blocked and can only continue by taking an action to fix the problem.
 
-* **Not recoverable / catastrophic error.** Used when a person can’t complete the task currently. Usually, it’s due to system error, the server is down, etc. For ideal next steps for users, include a contact method to fix the issue. If a contact method isn't available, provide guidance for the user to try again at a later time.
+*  **Not recoverable / catastrophic error.** Used when a person can’t complete the task currently. Usually, it’s due to system error, the server is down, etc. For ideal next steps for users, include a contact method to fix the issue. If a contact method isn't available, provide guidance for the user to try again at a later time.
 
 ## How to Write Errors Content
 
 Use complete sentences and brief, exact, but conversational language.
 
 1. Avoid the following words – personal pronouns, "please", and "sorry".
 
-2. Specify what went wrong.
+1. Specify what went wrong.
 
-3. Tell users how to fix the problem and continue the current task. If the problem can’t be resolved online, give users appropriate options to contact us or try again at a later time.
+1. Tell users how to fix the problem and continue the current task. If the problem can’t be resolved online, give users appropriate options to contact us or try again at a later time.
 
 ### Tone and Language
 
diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md
@@ -12,8 +12,8 @@ functional_areas:
 
 You can upgrade your Magento application from the command line if you installed the software by:
 
-- Downloading the [metapackage][] using `composer create-project`.
-- Installing the compressed archive.
+-  Downloading the [metapackage][] using `composer create-project`.
+-  Installing the compressed archive.
 
 Do not use this method to upgrade if you cloned the Magento 2 GitHub repository.
 Instead, see [Update the Magento application][] for upgrade instructions.
@@ -22,10 +22,10 @@ Instead, see [Update the Magento application][] for upgrade instructions.
 
 Complete the following prerequisites to prepare your environment before starting the upgrade process:
 
-- **Complete the Update and upgrade checklist**—To avoid possible errors during installation or upgrading, complete the [Update and upgrade checklist].
-- **Set the `pub/` directory root**—See [Modify docroot to improve security][] for more details.
-- **Check PHP and environment settings**—Verify that your PHP and other environment settings are compatible with the [system requirements].
-- **Switch to maintenance mode**—To prevent access to your store while it's being upgraded, switch your store to maintenance mode:
+-  **Complete the Update and upgrade checklist**—To avoid possible errors during installation or upgrading, complete the [Update and upgrade checklist].
+-  **Set the `pub/` directory root**—See [Modify docroot to improve security][] for more details.
+-  **Check PHP and environment settings**—Verify that your PHP and other environment settings are compatible with the [system requirements].
+-  **Switch to maintenance mode**—To prevent access to your store while it's being upgraded, switch your store to maintenance mode:
 
     ```bash
     bin/magento maintenance:enable
@@ -230,11 +230,11 @@ Open your storefront URL in a web browser to check whether the upgrade was succe
 If the application fails with a  `We're sorry, an error has occurred while generating this email.` error:
 
 1. Reset [file system ownership and permissions] as a user with `root` privileges.
-2. Clear the following directories:
-   - `var/cache/`
-   - `var/page_cache/`
-   - `generated/code/`
-3. Check your storefront in your web browser again.
+1. Clear the following directories:
+   -  `var/cache/`
+   -  `var/page_cache/`
+   -  `generated/code/`
+1. Check your storefront in your web browser again.
 
 ## Alternatives
 
@@ -243,7 +243,7 @@ There are alternatives methods that automate parts of the upgrade process:
 1. [Upgrade using the script][] (semi-automated process)
    Upgrading using the script process is a bit easier and less intensive if you have not made updates to values that the script affects.
    If you previously made updates, do not upgrade using the script. The script will override your updates.
-2. EXPERIMENTAL: [Upgrade using the custom Composer plugin][]
+1. EXPERIMENTAL: [Upgrade using the custom Composer plugin][]
    We are developing a [custom Composer plugin][] that enhances the semi-automated upgrade process.
 
 The upgrading scenario is the same for each of these options. Both use Composer and a command line interface.
diff --git a/guides/v2.3/comp-mgr/cli/upgrade-with-plugin.md b/guides/v2.3/comp-mgr/cli/upgrade-with-plugin.md
@@ -98,23 +98,24 @@ composer show magento/product-enterprise-edition {{ page.guide_version }}.* --al
 _Optional_—If the Magento updater is installed (it is located in `update/`) modify it:
 
 1. Backup `update/` directory.
-2. Create a Composer project.
+1. Create a Composer project.
 
    _{{ ce }} version {{ page.guide_version }}.2:_
 
-    ```bash
-    composer create-project --repository=https://repo.magento.com magento/project-community-edition={{ page.guide_version }}.2 temp_dir --no-install
-    ```
+   ```bash
+   composer create-project --repository=https://repo.magento.com magento/project-community-edition={{ page.guide_version }}.2 temp_dir --no-install
+   ```
+
+   _{{ ee }} version {{ page.guide_version }}.2:_
 
-    _{{ ee }} version {{ page.guide_version }}.2:_
+   ```bash
+   composer create-project --repository=https://repo.magento.com magento/project-enterprise-edition={{ page.guide_version }}.2 temp_dir --no-install
+   ```
 
-    ```bash
-    composer create-project --repository=https://repo.magento.com magento/project-enterprise-edition={{ page.guide_version }}.2 temp_dir --no-install
-    ```
+   {: .bs-callout-info }
+   If you need to use a repository that contains non-public packages, such as internal sandboxes, change the URL in `--repository` accordingly.
 
-    {: .bs-callout-info }
-      If you need to use a repository that contains non-public packages, such as internal sandboxes, change the URL in `--repository` accordingly.
-3. Remove the old `update/` directory and move the `temp_dir/update/` to the `update/` directory:
+1. Remove the old `update/` directory and move the `temp_dir/update/` to the `update/` directory:
 
    ```bash
    rm -rf update
@@ -195,11 +196,11 @@ Open your storefront URL in a web browser to check whether the upgrade was succe
 If the application fails with a  `We're sorry, an error has occurred while generating this email.` error:
 
 1. Reset [file system ownership and permissions] as a user with `root` privileges.
-2. Clear these directories:
-   - `var/cache`
-   - `var/page_cache`
-   - `generated/code`
-3. Check your storefront in your web browser again.
+1. Clear these directories:
+   -  `var/cache`
+   -  `var/page_cache`
+   -  `generated/code`
+1. Check your storefront in your web browser again.
 
 <!-- Link definitions -->
 
diff --git a/guides/v2.3/comp-mgr/cli/upgrade-with-script.md b/guides/v2.3/comp-mgr/cli/upgrade-with-script.md
@@ -12,13 +12,13 @@ Use [the manual process] if you previously made updates to the same values that
 
 The upgrade script:
 
-- Updates Magento with the {{ page.guide_version }} requirements.
-- Backs up the `composer.json` file.
-- Specifies the new version of the Magento metapackage.
-- Updates the `"require-dev"` section in the `composer.json` file.
-- Adds `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"` to the `"autoload":"psr-4"` section in the `composer.json` file.
-- Backs up and updates the `magento/updater`, if it has been installed.
-- Updates the `"name"`, `"version"`, and `"description"` fields in the `composer.json` file.
+-  Updates Magento with the {{ page.guide_version }} requirements.
+-  Backs up the `composer.json` file.
+-  Specifies the new version of the Magento metapackage.
+-  Updates the `"require-dev"` section in the `composer.json` file.
+-  Adds `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"` to the `"autoload":"psr-4"` section in the `composer.json` file.
+-  Backs up and updates the `magento/updater`, if it has been installed.
+-  Updates the `"name"`, `"version"`, and `"description"` fields in the `composer.json` file.
 
 ## Before you begin
 
@@ -94,11 +94,11 @@ Open your storefront URL in a web browser to check whether the upgrade was succe
 If the application fails with a  `We're sorry, an error has occurred while generating this email.` error:
 
 1. Reset [file system ownership and permissions] as a user with `root` privileges.
-2. Clear these directories:
-   - `<magento_root>/var/cache`
-   - `<magento_root>/var/page_cache`
-   - `<magento_root>/generated/code`
-3. Check your storefront in your web browser again.
+1. Clear these directories:
+   -  `<magento_root>/var/cache`
+   -  `<magento_root>/var/page_cache`
+   -  `<magento_root>/generated/code`
+1. Check your storefront in your web browser again.
 
 <!-- Link definitions -->
 
diff --git a/guides/v2.3/contributor-guide/contributing.md b/guides/v2.3/contributor-guide/contributing.md
@@ -196,10 +196,10 @@ This tool ports fixes automatically across versions with a few simple steps. It
 Access the tool at [porting.engcom.dev.magento.com](https://porting.engcom.dev.magento.com/). The first time you visit, you must log in and authorize with GitHub credentials. The tool performs all actions using your token.
 
 1. Visit [porting.engcom.dev.magento.com](https://porting.engcom.dev.magento.com/) and **Login with GitHub**.
-2. Copy and paste the pull request URL in **Select Pull Request for porting** and click **Next**.
-3. Select the target version for your port: **Up Port** or **Back Port**.
-4. Verify the summary of changes in **Port information**.
-5. Click **Create Job**. A job is created and started shortly after.
+1. Copy and paste the pull request URL in **Select Pull Request for porting** and click **Next**.
+1. Select the target version for your port: **Up Port** or **Back Port**.
+1. Verify the summary of changes in **Port information**.
+1. Click **Create Job**. A job is created and started shortly after.
 
 ![Magento Porting Tool]({{ site.baseurl }}/common/images/porting-tool-steps.png)
 
