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

Commit e50bb8b

Browse files
committed
Merge pull request #34 from magento/2.1_migration_update-include-php-dev
Update php-dev to match 2.0 content
2 parents 4cfb896 + 1ba0c51 commit e50bb8b

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

_includes/php-dev/component-root.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
<div markdown="1">
22

3-
### Root directory
4-
We refer to a component's *root directory* as the top-level directory in which you develop component code. Typically, this directory is located in one of the following directories relative to the Magento root directory:
3+
### Root directory location
4+
A component's root directory is the top-level directory for that component under which its folders and files are located. Depending on how your Magento development environment was installed, your component's root directory can be located in two places:
55

6-
* Subdirectory of `app` (*recommended*.) :
6+
* `<Magento install directory>/app`: This is the *recommended* location for component development. You can easily set up this type of environment by [Cloning the Magento 2 GitHub repository]({{ site.gdeurl21 }}install-gde/prereq/dev_install.html).
77

8-
* For modules, use `app/code`
9-
* For themes, use `app/design/frontend` (storefront theme) or `app/design/adminhtml` (Magento Admin theme)
10-
* For language packages, use `app/i18n`
8+
* For modules, use `app/code`.
9+
* For storefront themes, use `app/design/frontend`.
10+
* For Admin themes, use `app/design/adminhtml`.
11+
* For language packages, use `app/i18n`.
1112

12-
You can easily set up this type of environment by <a href="{{ site.gdeurl21 }}install-gde/prereq/dev_install.html">cloning the Magento 2 GitHub repository</a>. Typically, you cloned the repository if you want to to contribute code to the Magento 2 codebase.
13-
* `vendor`: You get this directory structure if you used the <a href="{{ site.gdeurl21 }}install-gde/prereq/integrator_install.html">`composer create-project`</a> command to get a Magento 2 metapackage (which downloads the CE or EE code), or if you extracted a <a href="{{ site.gdeurl21 }}install-gde/prereq/zip_install.html">compressed Magento 2 archive</a>.
13+
* `<Magento install directory>/vendor`: This location is found in the alternative setups where the [`composer create-project`]({{ site.gdeurl21 }}install-gde/prereq/integrator_install.html) command was used to get a Magento 2 metapackage (which downloads the CE or EE code), or a [compressed Magento 2 archive]({{ site.gdeurl21 }}install-gde/prereq/zip_install.html) was extracted in order to install Magento. *We do not recommend developing components using this setup*.
1414

1515
### Required files
16-
The following are required for all components:
16+
The following files are required for all components:
1717

18-
* `registration.php`: Among other things, specifies the directory in which the component is installed; by default, components install in the `<Magento root dir>/vendor` directory. For more information, see <a href="{{ site.gdeurl21 }}extension-dev-guide/component-registration.html" target="_blank">Component registration</a>.
19-
* `composer.json`: Specifies component dependencies. For more information, see <a href="{{ site.gdeurl21 }}extension-dev-guide/composer-integration.html" target="_blank">Composer integration</a>.
18+
* `registration.php`: Among other things, this file specifies the directory in which the component is installed by vendors in production environments. By default, composer automatically installs components in the `<Magento root dir>/vendor` directory. For more information, see [Component registration]({{ site.gdeurl21 }}extension-dev-guide/component-registration.html).
19+
* `composer.json`: Specifies component dependencies and other metadata. For more information, see [Composer integration]({{ site.gdeurl21 }}extension-dev-guide/composer-integration.html).
Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
<div markdown="1">
2-
3-
<h3 id="file-struct-comp-lang">Magento 2 language package file structure</h3>
1+
### Language package file structure
42
A typical directory structure for three language packages follows:
53

6-
├── de_DE
7-
│   ├── composer.json
8-
│   ├── language.xml
9-
│   ├── LICENSE_AFL.txt
10-
│   ├── LICENSE.txt
11-
│   └── registration.php
12-
├── en_US
13-
│   ├── composer.json
14-
│   ├── language.xml
15-
│   ├── LICENSE_AFL.txt
16-
│   ├── LICENSE.txt
17-
│   └── registration.php
18-
├── pt_BR
19-
│   ├── composer.json
20-
│   ├── language.xml
21-
│   ├── LICENSE_AFL.txt
22-
│   ├── LICENSE.txt
23-
│   └── registration.php
4+
~~~
5+
├── de_DE
6+
│   ├── composer.json
7+
│   ├── language.xml
8+
│   ├── LICENSE_AFL.txt
9+
│   ├── LICENSE.txt
10+
│   └── registration.php
11+
├── en_US
12+
│   ├── composer.json
13+
│   ├── language.xml
14+
│   ├── LICENSE_AFL.txt
15+
│   ├── LICENSE.txt
16+
│   └── registration.php
17+
├── pt_BR
18+
│   ├── composer.json
19+
│   ├── language.xml
20+
│   ├── LICENSE_AFL.txt
21+
│   ├── LICENSE.txt
22+
│   └── registration.php
23+
~~~
2424

25-
The only required directory for a language package is the top-level directory. Although not required, we recommend that the directory name match the <a href="http://www.iso.org/iso/home/standards/language_codes.htm" target="_blank">ISO</a> code to identify the locale.
25+
The only required directory for a language package is the top-level directory. Although not required, we recommend that the directory name match the [ISO](http://www.iso.org/iso/home/standards/language_codes.htm){:target="_blank"} code to identify the locale.
2626

27-
For more information about language packages, see <a href="{{ site.gdeurl21 }}config-guide/cli/config-cli-subcommands-i18n.html">Translation dictionaries and language packages</a>.
27+
For more information about language packages, see [Translation dictionaries and language packages]({{ site.gdeurl21 }}config-guide/cli/config-cli-subcommands-i18n.html).

0 commit comments

Comments
 (0)