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

Commit dd9d777

Browse files
Markdown linting: Fix MD001 errors and enable rule (#5561)
* MAGEDOC-5240: enabled MD001 header increment rule * MAGEDOC-5240: additional fixes * Added a new class for fake headers so we can implement MD001 * Added new devdocs class for pseudo headers * Replaced all reference headers with pseudo header class * Fix global replace error * Fixed more global replace issues * More fixes and replace NExt steps in cloud * Add new line * Peer review edits * Add class to Previous step * Fixed MD012 error * Changed long H3s to bullets * Fix MD001 error after fixing merge conflicts
1 parent 51edc65 commit dd9d777

File tree

239 files changed

+675
-450
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

239 files changed

+675
-450
lines changed

_checks/styles/style-rules-prod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
exclude_rule 'MD001'
1+
rule 'MD001'
22
exclude_rule 'MD002'
33
rule 'MD003', :style => :atx
44
exclude_rule 'MD004'

_includes/install/web/install-web_4-customize-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
1. Click **Next**.
1919

20-
#### General module configuration options {#instgde-install-magento-web-step4-depend1}
20+
### General module configuration options {#instgde-install-magento-web-step4-depend1}
2121

2222
Modules are listed in **Advanced Modules Configuration** in alphabetical order; the order has nothing to do with dependencies.
2323

@@ -37,7 +37,7 @@ The following figure shows an example of disabling the `Magento_GoogleAnalytics`
3737

3838
![Disabling a module]({{ site.baseurl }}/common/images/install_wizard_disable-google.png)
3939

40-
#### Module dependency errors {#instgde-install-magento-web-step4-depend2}
40+
### Module dependency errors {#instgde-install-magento-web-step4-depend2}
4141

4242
A dependency error occurs when two inter-dependent modules are disabled at the same time.
4343

_videos/fundamentals/create-a-new-module.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Let’s go through each of these steps in detail.
2121

2222
## Create the module folder
2323

24-
#### There are two possible locations for modules in Magento 2: the app/code folder and the vendor folder
24+
### There are two possible locations for modules in Magento 2: the app/code folder and the vendor folder
2525

2626
Depending on how Magento 2 has been installed, core modules can either be located in the `vendor/magento/magento-*`folders (for composer installation) or in the `app/code/Magento/` folder (for cloning GitHub).
2727

28-
#### Which of these locations should you choose for your new module?
28+
### Which of these locations should you choose for your new module?
2929

3030
If you build a module for a specific project, it is best to choose the app/code folder and commit to the project's repository.
3131

_videos/fundamentals/create-a-new-page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Learning/HelloPage/registration.php
4949
Learning/HelloPage/etc/module.xml
5050
```
5151

52-
#### registration.php
52+
### registration.php
5353
```php
5454
<?php /**
5555
* Copyright © 2016 Magento. All rights reserved. * See COPYING.txt for license details.
@@ -59,7 +59,7 @@ __DIR__
5959
);
6060
```
6161

62-
#### module.xml
62+
### module.xml
6363
```xml
6464
<?xml version="1.0"?>
6565
<!--

common/css/devdocs.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@
2828
margin-left: 1.0em;
2929
}
3030

31+
/* Paragraph that introduces important reference information (e.g., Related topics, Next step, Previous step), but does not qualify as a proper heading. Mimics the current H3 style */
32+
.ref-header {
33+
font-weight: bold;
34+
font-size: 1.3em;
35+
margin: 1.5em 0 0.5em 0;
36+
}
37+
3138
.message-banner.version-banner {
3239
margin-bottom: 15px;
3340
}

guides/v2.2/advanced-reporting/data-collection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ It cannot contain any parameters.
196196
...
197197
```
198198

199-
## Related topics
199+
{:.ref-header}
200+
Related topics
200201

201202
[Modules providing advanced reporting][modules]
202203

guides/v2.2/advanced-reporting/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ To avoid system overload during its prime time, you can set the preferable time
3030

3131
Though the Analytics module provides API, it is used specifically to interchange data with the MBI. We do not recommend to extend the advanced reporting functionality in this version.
3232

33-
## Related topics
33+
{:.ref-header}
34+
Related topics
3435

3536
[Magento modules that implement the functionality][modules]{:target="_blank"}
3637

guides/v2.2/architecture/archi_perspectives/ABasics_intro.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ The following discussion focuses on how these topics apply directly to Magento:
1515
* Event-driven architecture
1616
* Security
1717

18-
## Related topics
18+
{:.ref-header}
19+
Related topics
1920

2021
[Architectural diagrams]({{page.baseurl}}/architecture/archi_perspectives/arch_diagrams.html)
2122

guides/v2.2/architecture/archi_perspectives/ALayers_intro.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Layered application design offers many advantages, but users of Magento will app
2222

2323
* Clear organization of code predictably points [extension](https://glossary.magento.com/extension) developers to code location.
2424

25-
## Related topics
25+
{:.ref-header}
26+
Related topics
2627

2728
[Architectural diagrams]({{page.baseurl}}/architecture/archi_perspectives/arch_diagrams.html)
2829

guides/v2.2/architecture/archi_perspectives/arch_diagrams.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The following diagram illustrates the components and shows the "layers" or tiers
1414

1515
![Architectural Diagram]({{site.baseurl}}/common/images/archi_diagram_desired-state.png)
1616

17-
## Related topics
17+
{:.ref-header}
18+
Related topics
1819

1920
* [Architecture layers overview]({{page.baseurl}}/architecture/archi_perspectives/ALayers_intro.html)

0 commit comments

Comments
 (0)