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

Commit 4227f8e

Browse files
jignesh-baldhajeff-matthews
authored andcommitted
HTML anchor to markdown #1 (#2715)
1 parent 28c3b6b commit 4227f8e

File tree

111 files changed

+694
-724
lines changed

Some content is hidden

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

111 files changed

+694
-724
lines changed

guides/v2.1/cloud/reference/git-integration.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ If you need help understand Git, you can review the following resources:
2020
* [Git video](https://www.youtube.com/watch?v=8KCQe9Pm1kg){:target="\_blank"} with DevForge to understand how people use the repo and commands with a fun story
2121

2222
## Git CLI and clients {#clients}
23-
24-
You can interact with Git using [CLI commands](https://git-scm.com/documentation){:target="\_blank"} or using a Git client. Git provides a <a href="https://git-scm.com/downloads" target="\_blank">Git client</a> option, or you can use other clients such as installed on your computer to be able to interact with {{site.data.var.ece}}.
23+
You can interact with Git using [CLI commands](https://git-scm.com/documentation){:target="\_blank"} or using a Git client. Git provides a [Git client](https://git-scm.com/downloads){:target="\_blank"} option, or you can use other clients such as installed on your computer to be able to interact with {{site.data.var.ece}}.
2524

2625
Not everyone remembers [Git](https://git-scm.com/docs){:target="\_blank"} commands with ease. If you want a Git client, use any client of your choice. Some developers use clients including [GitKraken](https://www.gitkraken.com/){:target="\_blank"} and [SmartGit](https://www.syntevo.com/smartgit/){:target="\_blank"}.
2726

guides/v2.1/coding-standards/docblock-standard-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ functional_areas:
1313
## Introduction {#frontend-dev-guide-javascript-js-coding-docblock-overview}
1414

1515
To add {% glossarytooltip 312b4baf-15f7-4968-944e-c814d53de218 %}JavaScript{% endglossarytooltip %} code inline documentation, follow these guidelines. Some parts of Magento code may not comply with this standard, but we are working to gradually improve this. Following these standard is optional for 3rd-party Magento developers, but will help to create consistent, clean, and easy to read inline documentation.
16-
This standard are a subset of <a href="https://google.github.io/styleguide/javascriptguide.xml" target="_blank">Google JavaScript Style Guide</a> regulations.
16+
This standard are a subset of [Google JavaScript Style Guide](https://google.github.io/styleguide/javascriptguide.xml){:target="_blank"} regulations.
1717

1818
<p>Use <a href="http://www.ietf.org/rfc/rfc2119.txt" target="_blank">RFC 2119</a> to interpret the "must," "must not," "required," "shall," "shall not," "should," "should not," "recommended," "may," and "optional" keywords.</p>
1919

guides/v2.1/comp-mgr/prereq/prereq_cron.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To enable us to update or upgrade your system, you must configure two cron jobs.
1414

1515
The cron jobs schedule tasks for the Setup Wizard and for the updater application. These applications work together to install, update, and upgrade the Magento application and components.
1616

17-
Enable the cron jobs as <a href="http://ss64.com/bash/crontab.html" target="_blank">crontabs</a> for the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) because that user runs the updater application for the Web Setup Wizard.
17+
Enable the cron jobs as [crontabs](http://ss64.com/bash/crontab.html){:target="_blank"} for the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) because that user runs the updater application for the Web Setup Wizard.
1818

1919
{% include config/setup-cron.md %}
2020

guides/v2.1/comp-mgr/trouble/cman/were-sorry.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ Enter your <a href="{{ page.baseurl }}/comp-mgr/prereq/prereq_auth-token.html">a
3030
If that doesn't work, try generating <a href="{{ page.baseurl }}/install-gde/prereq/connect-auth.html">new authentication keys</a> and enter those in the Admin. Then try your upgrade again.
3131

3232
### Problem: the updater application isn't initialized {#updater}
33-
34-
In some cases (especially if you downloaded the Magento software from <a href="https://packagist.org/" target="_blank">packagist</a>), the updater application might not be initialized. (A common way for this to happen is to not specify our `https://repo.magento.com` repository in the `composer create-project` command.)
33+
In some cases (especially if you downloaded the Magento software from [packagist](https://packagist.org/){:target="_blank"}), the updater application might not be initialized. (A common way for this to happen is to not specify our `https://repo.magento.com` repository in the `composer create-project` command.)
3534

3635
The updater application uses a cron job to run the upgrade; if it's not initialized, your update fails.
3736

guides/v2.1/config-guide/cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Magento enables you to configure alternatives to the default file system caching
2727

2828
Magento uses the following caching terminology:
2929

30-
* *Frontend*: Similar to an interface or gateway to cache storage, implemented by <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Cache/Frontend" target="_blank">Magento\Framework\Cache\Frontend</a>.
30+
* *Frontend*: Similar to an interface or gateway to cache storage, implemented by [Magento\Framework\Cache\Frontend]({{ site.mage2000url }}lib/internal/Magento/Framework/Cache/Frontend){:target="_blank"}.
3131
* *Cache types*: Can be one of the types provided with Magento or you can <a href="{{ page.baseurl }}/config-guide/cache/caching-cache-type.html">create your own</a>.
32-
* *Backend*: Specifies details about <a href="http://framework.zend.com/manual/1.12/en/zend.cache.backends.html" target="_blank">cache storage</a>, implemented by <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Cache/Backend" target="_blank">Magento\Framework\Cache\Backend</a>
32+
* *Backend*: Specifies details about [cache storage](http://framework.zend.com/manual/1.12/en/zend.cache.backends.html){:target="_blank"}, implemented by [Magento\Framework\Cache\Backend]({{ site.mage2000url }}lib/internal/Magento/Framework/Cache/Backend){:target="_blank"}
3333
* *Two-level backend*: Stores cache records in two backends&mdash;a faster one and a slower one.
3434

3535
Two-level backend cache configuration is beyond the scope of this guide at this time.

guides/v2.1/config-guide/cli/config-cli-subcommands-compiler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This section discusses the basics of code compilation. Code compilation consists
2424
- Repositories code generation (that is, generated code for APIs)
2525
- Service data attributes generation (that is, generated {% glossarytooltip 55774db9-bf9d-40f3-83db-b10cc5ae3b68 %}extension{% endglossarytooltip %} classes for data objects)
2626

27-
You can find code compilation in classes in the <a href="{{ site.mage2100url }}setup/src/Magento/Setup/Module/Di/App/Task/Operation" target="\_blank">\Magento\Setup\Module\Di\App\Task\Operation</a> {% glossarytooltip 621ef86b-7314-4fbc-a80d-ab7fa45a27cb %}namespace{% endglossarytooltip %}.
27+
You can find code compilation in classes in the [\Magento\Setup\Module\Di\App\Task\Operation]({{ site.mage2100url }}setup/src/Magento/Setup/Module/Di/App/Task/Operation){:target="\_blank"} {% glossarytooltip 621ef86b-7314-4fbc-a80d-ab7fa45a27cb %}namespace{% endglossarytooltip %}.
2828

2929
<div class="bs-callout bs-callout-warning" markdown="1">
3030
In this release, the Magento software doesn't support the multi-tenant compiler (that is, the `bin/magento setup:di:compile-multi-tenant` command).

guides/v2.1/config-guide/cli/config-cli-subcommands-i18n.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To translate words and phrases, you must:
4242
After that:
4343

4444
1. You can package the translation dictionaries into a language package and provide the package to the Magento store administrator.
45-
2. In the Magento Admin, the store administrator <a href="http://docs.magento.com/m2/ce/user_guide/stores/store-language-add.html?Highlight=translation" target="\_blank">configures the translations</a>.
45+
2. In the Magento Admin, the store administrator [configures the translations](http://docs.magento.com/m2/ce/user_guide/stores/store-language-add.html?Highlight=translation){:target="\_blank"}.
4646

4747
Command options:
4848

@@ -150,7 +150,7 @@ The following table explains this command's parameters and values:
150150
</tr>
151151
<tr>
152152
<td><p>&lt;locale></p></td>
153-
<td><p><a href="http://www.iso.org/iso/home/standards/language_codes.htm" target="\_blank">ISO 639-1</a> (language) and <a href="http://www.iso.org/iso/country_codes.htm" target="\_blank">ISO 3166</a> (country) identifier of language used as file name for all resulting .csv files. Examples: <code>de_DE</code>, <code>pt_PT</code>, <code>pt_BR</code>. </p>
153+
<td><p>[ISO 639-1](http://www.iso.org/iso/home/standards/language_codes.htm){:target="\_blank"} (language) and [ISO 3166](http://www.iso.org/iso/country_codes.htm){:target="\_blank"} (country) identifier of language used as file name for all resulting .csv files. Examples: <code>de_DE</code>, <code>pt_PT</code>, <code>pt_BR</code>. </p>
154154
</td>
155155
<td>
156156
<p>Yes</p>
@@ -189,7 +189,7 @@ A language package is a directory under `app/i18n/<VendorName>` in the Magento f
189189
The entire path must be all lowercase.
190190
</div>
191191

192-
For an example, see the <a href="{{ site.mage2000url }}app/i18n/magento/de_de/registration.php" target="\_blank"><code>de_de</code> language package</a>.
192+
For an example, see the [<code>de_de</code> language package]({{ site.mage2000url }}app/i18n/magento/de_de/registration.php){:target="\_blank"}.
193193

194194
To create these files:
195195

@@ -262,7 +262,7 @@ If the Magento application cannot find word or phrase in the `en_GB` package, it
262262
1. `<vendorname>/en_ca_package`
263263
1. `<vendorname>/en_us_package`
264264

265-
Specifying all inheritances between the language packages might result in creating circular inheritance chains. Use <a href="{{ site.mage2000url }}dev/tests/static/testsuite/Magento/Test/Integrity/App/Language/CircularDependencyTest.php" target="\_blank">Magento\Test\Integrity\App\Language\CircularDependencyTest</a> test to locate and fix such chains.
265+
Specifying all inheritances between the language packages might result in creating circular inheritance chains. Use [Magento\Test\Integrity\App\Language\CircularDependencyTest]({{ site.mage2000url }}dev/tests/static/testsuite/Magento/Test/Integrity/App/Language/CircularDependencyTest.php){:target="\_blank"} test to locate and fix such chains.
266266

267267
### Configure multiple packages for a language {#m2devgde-xlate-severalpacks}
268268

guides/v2.1/config-guide/cli/config-cli-subcommands-urn.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ functional_areas:
1414
{% include config/cli-intro.md %}
1515

1616
## Overview of URN highlighter
17-
18-
Magento code references all XSD schemas as <a href="https://www.ietf.org/rfc/rfc2141.txt" target="\_blank">Uniform Resource Names (URNs)</a>. If you're developing code and need to reference XSDs, this command configures your integrated developer environment (IDE) to recognize and highlight URNs. This makes development easier.
17+
Magento code references all XSD schemas as [Uniform Resource Names (URNs)](https://www.ietf.org/rfc/rfc2141.txt){:target="\_blank"}. If you're developing code and need to reference XSDs, this command configures your integrated developer environment (IDE) to recognize and highlight URNs. This makes development easier.
1918

2019
By default, an IDE like PHPStorm is not configured to recognize URNs and, as a result, they display in red text as follows:
2120

guides/v2.1/config-guide/config/config-files.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,17 @@ Following are common terms used in this topic:
3535
This section discusses how configuration files are loaded and merged.
3636

3737
### How Magento loads configuration files {#config-files-load}
38-
3938
Magento loads configuration files in the following order (all paths are relative to your Magento installation directory):
4039

41-
* Primary configuration (<a href="{{ site.mage2000url }}app/etc/di.xml" target="_blank">app/etc/di.xml</a>). This file is used to bootstrap Magento.
40+
* Primary configuration ([app/etc/di.xml]({{ site.mage2000url }}app/etc/di.xml){:target="_blank"}). This file is used to bootstrap Magento.
4241
* Global configurations from modules (`<your component base dir>/<vendorname>/<component-type>-<component-name>/etc/*.xml`). Collects certain configuration files from all modules and merges them together.
4342
* Area-specific configuration from modules (`<your component base dir>/<vendorname>/<component-type>-<component-name>/etc/<area>/*.xml`). Collects configuration files from all modules and merges them into the global configuration. Some area-specific configurations can override or extend the global configuration.
4443

4544
{% include vendor/types-def.md %}
4645

47-
* `<component-name>`: Name of your component as defined in <a href="{{ site.mage2000url }}composer.json" target="_blank">composer.json</a>.
46+
* `<component-name>`: Name of your component as defined in [composer.json]({{ site.mage2000url }}composer.json){:target="_blank"}.
4847

4948
### Configuration file merge {#config-files-load-merge-merge}
50-
5149
Nodes in configuration files are merged based on their fully qualified XPaths, which has a special attribute defined in `$idAttributes` array declared as its identifier. This identifier must be unique for all nodes nested under the same parent node.
5250

5351
Magento's merge algorithm follows:
@@ -116,21 +114,20 @@ The following table shows each configuration type and the Magento configuration
116114
</table>
117115

118116
### Configuration interfaces {#config-files-classes-int}
119-
120-
You can interact with configuration files using interfaces under <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config" target="_blank">Magento\Framework\Config</a>. You can also use these interfaces if you create a new configuration types.
117+
You can interact with configuration files using interfaces under [Magento\Framework\Config]({{ site.mage2000url }}lib/internal/Magento/Framework/Config){:target="_blank"}. You can also use these interfaces if you create a new configuration types.
121118

122119
`Magento\Framework\Config` provides the following interfaces:
123120

124-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/ConverterInterface.php" target="_blank">Framework\Config\ConverterInterface</a>, which converts the {% glossarytooltip 8c0645c5-aa6b-4a52-8266-5659a8b9d079 %}XML{% endglossarytooltip %} into an in-memory array representation of the configurations.
125-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/DataInterface.php" target="_blank">Framework\Config\DataInterface</a>, which retrieves the configuration data in a specified scope.
126-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/FileResolverInterface.php" target="_blank">Framework\Config\FileResolverInterface</a>, which identifies the location of files to be read by <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/ReaderInterface.php" target="_blank">Magento\Framework\Config\ReaderInterface</a>.
127-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/ReaderInterface.php" target="_blank">Framework\Config\ReaderInterface</a>, which reads the configuration data from storage and selects the storage from which it reads.
121+
* [Framework\Config\ConverterInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/ConverterInterface.php){:target="_blank"}, which converts the {% glossarytooltip 8c0645c5-aa6b-4a52-8266-5659a8b9d079 %}XML{% endglossarytooltip %} into an in-memory array representation of the configurations.
122+
* [Framework\Config\DataInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/DataInterface.php){:target="_blank"}, which retrieves the configuration data in a specified scope.
123+
* [Framework\Config\FileResolverInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/FileResolverInterface.php){:target="_blank"}, which identifies the location of files to be read by [Magento\Framework\Config\ReaderInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/ReaderInterface.php){:target="_blank"}.
124+
* [Framework\Config\ReaderInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/ReaderInterface.php){:target="_blank"}, which reads the configuration data from storage and selects the storage from which it reads.
128125

129126
That is, the file system, database, other storage merges the configuration files according to the merging rules, and validates the configuration files with the validation schemas.
130127

131-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/SchemaLocatorInterface.php" target="_blank">Framework\Config\SchemaLocatorInterface</a>, which locates the XSD schema.
132-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/ScopeListInterface.php" target="_blank">Framework\Config\ScopeListInterface</a>, which returns a list of scopes.
133-
* <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/ValidationStateInterface.php" target="_blank">Framework\Config\ValidationStateInterface</a>, which retrieves the validation state.
128+
* [Framework\Config\SchemaLocatorInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/SchemaLocatorInterface.php){:target="_blank"}, which locates the XSD schema.
129+
* [Framework\Config\ScopeListInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/ScopeListInterface.php){:target="_blank"}, which returns a list of scopes.
130+
* [Framework\Config\ValidationStateInterface]({{ site.mage2000url }}lib/internal/Magento/Framework/Config/ValidationStateInterface.php){:target="_blank"}, which retrieves the validation state.
134131

135132
#### Related topics
136133

guides/v2.1/config-guide/config/config-php.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ The Magento 2 deployment configuration replaces `local.xml` in Magento 1.x.
4646
Unlike other [module configuration files]({{ page.baseurl }}/config-guide/config/config-files.html), Magento's deployment configuration is loaded into memory when Magento initializes, is not merged with any other files, and cannot be extended. (`config.php` and `env.php` are merged with each other, however.)
4747

4848
## Details about the deployment configuration {#config-php-contents}
49-
`config.php` and `env.php` are {% glossarytooltip bf703ab1-ca4b-48f9-b2b7-16a81fd46e02 %}PHP{% endglossarytooltip %} files that return a <a href="http://www.w3schools.com/php/php_arrays.asp" target="_blank">multi-dimensional associative array</a>, which is basically a hierarchical arrangement of configuration parameters and values.
49+
`config.php` and `env.php` are {% glossarytooltip bf703ab1-ca4b-48f9-b2b7-16a81fd46e02 %}PHP{% endglossarytooltip %} files that return a [multi-dimensional associative array](http://www.w3schools.com/php/php_arrays.asp){:target="_blank"}, which is basically a hierarchical arrangement of configuration parameters and values.
5050

5151
On the top level of this array are *configuration segments*. A segment has arbitrary content (a scalar value or a nested array) distinguished by an arbitrary key&mdash;where both the key and its value are defined by the Magento framework.
5252

53-
<a href="{{ site.mage2000url }}/lib/internal/Magento/Framework/App/DeploymentConfig.php" target="_blank">Magento\Framework\App\DeploymentConfig</a> merely provides access to these sections but does not allow you to extend them.
53+
[Magento\Framework\App\DeploymentConfig]({{ site.mage2000url }}/lib/internal/Magento/Framework/App/DeploymentConfig.php){:target="_blank"} merely provides access to these sections but does not allow you to extend them.
5454

5555
On the next hierarchy level, items in each segment are ordered according to the {% glossarytooltip c1e4242b-1f1a-44c3-9d72-1d5b1435e142 %}module{% endglossarytooltip %} sequence definition, which is obtained by merging all modules' configuration files, with the {% glossarytooltip 53da11f1-d0b8-4a7e-b078-1e099462b409 %}exception{% endglossarytooltip %} of disabled modules.
5656

guides/v2.1/config-guide/cron/custom-cron-ref.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The resulting `crontab.xml` with two groups may look like this:
7777
</config>
7878
{%endhighlight%}
7979

80-
As an example, see <a href="{{ site.mage2000url }}app/code/Magento/Customer/etc/crontab.xml" target="_blank">Magento_Customer crontab.xml</a>.
80+
As an example, see [Magento_Customer crontab.xml]({{ site.mage2000url }}app/code/Magento/Customer/etc/crontab.xml){:target="_blank"}.
8181

8282
#### Specifying Cron group options {#specify-cron-group-options}
8383

0 commit comments

Comments
 (0)