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

Upgrade mdl, enable MD046 #7842

Merged
merged 5 commits into from
Sep 8, 2020
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ jobs:
with:
ruby-version: 2.6
- name: Install mdl gem
run: gem install mdl -v '0.7.0'
run: gem install mdl
- name: Run mdl
run: mdl --style=_checks/styles/style-rules-prod --ignore-front-matter --git-recurse -- .
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ gem 'wdm', platform: :mswin

group :test do
gem 'html-proofer'
gem 'mdl', '= 0.7.0'
gem 'mdl'
gem 'launchy'
end

Expand Down
16 changes: 10 additions & 6 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ GEM
algoliasearch (1.27.2)
httpclient (~> 2.8, >= 2.8.3)
json (>= 1.5.1)
chef-utils (16.4.41)
colorator (1.1.0)
concurrent-ruby (1.1.6)
em-websocket (0.5.1)
Expand Down Expand Up @@ -106,16 +107,19 @@ GEM
listen (3.2.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mdl (0.7.0)
kramdown (~> 2.0)
kramdown-parser-gfm (~> 1.0)
mdl (0.11.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.1)
mixlib-cli (~> 2.1, >= 2.1.1)
mixlib-config (>= 2.2.1, < 4)
mixlib-shellout
mercenary (0.4.0)
mini_portile2 (2.4.0)
mixlib-cli (2.1.6)
mixlib-config (3.0.6)
mixlib-cli (2.1.8)
mixlib-config (3.0.9)
tomlrb
mixlib-shellout (3.1.4)
chef-utils
multipart-post (2.1.1)
netrc (0.11.0)
nokogiri (1.10.9)
Expand Down Expand Up @@ -178,7 +182,7 @@ DEPENDENCIES
jekyll-sitemap
jekyll-titles-from-headings
launchy
mdl (= 0.7.0)
mdl
rake
wdm
whatsup_github
Expand Down
2 changes: 1 addition & 1 deletion _checks/styles/style-rules-prod
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ rule 'MD038' # Spaces inside code span elements
exclude_rule 'MD039'
rule 'MD040' # Fenced code blocks should have a language specified
exclude_rule 'MD041'
exclude_rule 'MD046'
rule 'MD046'
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,17 @@ To continue the import, enter `yes`.

If deployment configuration files contain some data to import, a message similar to the following is displayed:

Start import:
Some information about importing
```terminal
Start import:
Some information about importing
```

If deployment configuration files do not contain any data to import, a message similar to the following is displayed:

Start import:
Nothing to import
```terminal
Start import:
Nothing to import
```

## What we import

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ mkdir -p Controller/Adminhtml/HelloWorld
Inside `Controller/Adminhtml/HelloWorld` directory, create the file `Index.php`. This file is the class assigned to the default Index action for the `HelloWorld` controller. Since the admin area serves this page, the file belongs in the `Adminhtml` directory, and the class itself extends [`\Magento\Backend\App\Action`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Backend/App/Action.php){:target="_blank"}.

{% collapsible File content for Index.php %}
```php

```php
<?php
namespace MyCompany\ExampleAdminNewPage\Controller\Adminhtml\HelloWorld;

Expand Down Expand Up @@ -236,7 +237,8 @@ class Index extends Action implements HttpGetActionInterface
return $resultPage;
}
}
```
```

{% endcollapsible %}

## Page view
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Inside the file, create the class `UpgradeData` which implements `\Magento\Frame
Example upgrade script content:

{% collapsible Show upgrade script content%}

```php
namespace Magento\CustomModule\Setup;

Expand Down Expand Up @@ -117,6 +118,7 @@ class UpgradeData implements \Magento\Framework\Setup\UpgradeDataInterface
}
}
```

{% endcollapsible %}

## Step 2: Check that the module exists {#step-2}
Expand Down Expand Up @@ -274,6 +276,7 @@ This field contains nested serialized data that needs conversion.
Since you cannot assume the format of the data when initially converted, the following example also checks the format and uses the appropriate methods to unserialize and serialize the data using the original format.

{% collapsible Show code %}

```php
namespace Magento\CustomModule\Setup;

Expand Down Expand Up @@ -356,6 +359,7 @@ class SerializedToJsonDataConverter implements \Magento\Framework\DB\DataConvert
}
}
```

{% endcollapsible %}

After creating your custom data converter class, use the `FieldDataConverterFactory` to create a `FieldDataConverter` instance with your custom converter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,11 @@ bin/magento app:config:dump

A message similar to the following is displayed:

The configuration file doesn't contain sensitive data for security reasons. Sensitive data can be stored in the following environment variables:
CONFIG__DEFAULT__PAYMENT__TEST__PASWORD for payment/test/password
Done.
```terminal
The configuration file doesn't contain sensitive data for security reasons. Sensitive data can be stored in the following environment variables:
CONFIG__DEFAULT__PAYMENT__TEST__PASWORD for payment/test/password
Done.
```

### Example: System-specific settings

Expand Down
8 changes: 5 additions & 3 deletions src/guides/v2.3/extension-dev-guide/package/package_module.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,17 @@ The following example is a `composer.json` file for a module:

Create a package of your extension by performing a zip operation on the directory with your extension (excluding unnecessary directories). For example:

zip -r vendor-name_package-name-1.0.0.zip package-path/ -x 'package-path/.git/*'
```bash
zip -r vendor-name_package-name-1.0.0.zip package-path/ -x 'package-path/.git/*'
```

Use alphanumeric characters for the package filename with dashes to separate words. Do not use whitespaces.

Magento can retrieve your extension package from any valid GitHub [URL](https://glossary.magento.com/url).

<!-- After you have created the module's `composer.json` file in the root directory of the module, Composer can recognize your package as compatible with its deployment strategy. Such packages can be published to a code repository (GitHub, SVN, etc.), packagist.org, or on your own private package repository. -->

{:.bs-callout-info}
{:.bs-callout-info}
Third party repositories are supported.

### Hosting on GitHub and Packagist {#hosting}
Expand All @@ -142,7 +144,7 @@ Prerequisite: Git must be set up on your machine.

### Hosting on a private repository {#private_repos}

{:.bs-callout-info}
{:.bs-callout-info}
If you use the Setup Wizard, you must use the Magento Marketplace repository. A private repository can be used for development or private code but installation must be done with a command line interface (you can install a package that specifies a private repository only with a command line installation).

1. Set up your own Composer packaging repository using a system such as [Satis](https://getcomposer.org/doc/articles/handling-private-packages-with-satis.md) or [Private Packagist](https://packagist.com/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ HTML;
Change the instances of `http://magento.host` in this example to a valid base URL.

{% collapsible Click to expand %}

```php
<?php

Expand Down Expand Up @@ -451,6 +452,7 @@ class OauthClient extends AbstractService
}
}
```

{% endcollapsible %}

{:.ref-header}
Expand Down
7 changes: 3 additions & 4 deletions src/guides/v2.3/install-gde/prereq/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,10 @@ To enable Apache to initiate a connection to another host with SELinux enabled:
getenforce
```

`Enforcing` displays to confirm that SELinux is running.
`Enforcing` displays to confirm that SELinux is running.

* CentOS: `setsebool -P httpd_can_network_connect=1`

* Ubuntu: `setsebool -P apache2_can_network_connect=1`
* CentOS: `setsebool -P httpd_can_network_connect=1`
* Ubuntu: `setsebool -P apache2_can_network_connect=1`

## Opening Ports In Your Firewall {#install-iptables}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ There are times when an action needs to be confirmed. In these cases, the user

![](img/datatable11.jpg)

Once an action is taken, success/fail messaging should appear as an overlay which fades away. Certain actions may
require that an Undo action be provided. This experience should be the same whether a single file is being deleted via the "actions" button for that record or 1 or more files have been selected via a checkbox and deleted via the mass actions delete.
Once an action is taken, success/fail messaging should appear as an overlay which fades away. Certain actions mayrequire that an Undo action be provided. This experience should be the same whether a single file is being deleted via the "actions" button for that record or 1 or more files have been selected via a checkbox and deleted via the mass actions delete.

![](img/datatable12.jpg)

Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Magento Commerce 2.3.0 includes a wealth of new features as well as hundreds of

* **GraphQL API** is now available with Magento 2.3.0. This API provides an alternative to REST and SOAP web APIs for custom frontend development, including headless storefronts and PWAs. See [GraphQL Developer Guide]({{site.baseurl}}/guides/v2.3/graphql/index.html) for more information about Magento's implementation of this data query language. GraphQL is a Magento Community Engineering special project open to contributors. To take part and contribute, see the [GraphQL GitHub](https://github.com/magento/graphql-ce) repository and [wiki](https://github.com/magento/graphql-ce/wiki) to get started. Join us in our [Slack](https://magentocommeng.slack.com/messages/C8076E0KS) channel (or [self signup](https://tinyurl.com/engcom-slack)) to discuss the project.

* **Asynchronous Web APIs** allow any previous Magento REST APIs to be called asynchronously. This community-contributed feature includes separate status APIs that have been created to check the status of each request. Developers can now use the asynchronous APIs in conjunction with queues that have also been migrated to Magento Open Source. See [Asynchronous web endpoints]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) for more information.
* **Asynchronous Web APIs** allow any previous Magento REST APIs to be called asynchronously. This community-contributed feature includes separate status APIs that have been created to check the status of each request. Developers can now use the asynchronous APIs in conjunction with queues that have also been migrated to Magento Open Source. See [Asynchronous web endpoints]({{ page.baseurl }}/rest/asynchronous-web-endpoints.html) for more information.

* **Bulk Web APIs** allow all existing REST APIs to accept payloads with multiple entities. These community-contributed bulk APIs support more efficient and scalable implementations that eliminate round-trip network overhead. Like asynchronous APIs, bulk web APIs can be used in conjunction with queues that have also been migrated to Magento Open Source. [See Bulk endpoints]({{ page.baseurl }}/rest/bulk-endpoints.html) for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ This release includes over 30 security enhancements that help close cross-site s

* Customer address handling has been rewritten with UI components that increase platform performance, which in turn streamlines the management of customers with 3000 and more addresses. <!--- MAGETWO-94346 95249-->

* The Admin order creation page now handles customer accounts with 3000 addresses without performance issues. <!--- MC-5683-->
* The Admin order creation page now handles customer accounts with 3000 addresses without performance issues. <!--- MC-5683-->

* Magento now displays the list of additional customer addresses contained in the storefront customer address book as a grid, which has improved performance for customers with many additional addresses associated with their accounts. [Address Book](https://docs.magento.com/m2/ee/user_guide/customers/account-dashboard-address-book.html) describes how to use this enhanced feature. <!--- MAGETWO-94347-->

Expand Down