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

Merge at end of sprint 23 #196

Merged
75 commits merged into from
Feb 18, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
11e68e1
1904
Jan 27, 2015
de51ef4
magedoc-2141
Jan 27, 2015
f87559e
magedoc 1616
Feb 4, 2015
6a2d763
1616
Feb 4, 2015
3ec414d
1616
Feb 4, 2015
ffc3d11
magedoc1616
Feb 4, 2015
ca6f60c
1616
Feb 4, 2015
edb7dfe
1616
Feb 4, 2015
aca1433
going crazy
Feb 4, 2015
478897d
1616
Feb 4, 2015
f795608
Merge branch 'develop' of github.com:magento/devdocs into devdocs-23-m8
Feb 5, 2015
74f3c75
1616
Feb 5, 2015
e6b0bf1
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 5, 2015
1341b3b
MAGEDOC-2173. Review configuration files topics
Feb 5, 2015
5b932bf
MAGEDOC-2173. Fixing bad links
Feb 5, 2015
194ffac
MAGEDOC-2173. Proofreading
Feb 5, 2015
5e698ab
Merge branch 'pubs23_MAGEDOC-1913' of github.corp.ebay.com:Magento/de…
Feb 5, 2015
41e0ae6
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 7, 2015
8daca1d
MAGEDOC-1913. General improvements to install guide; adding && to app…
Feb 7, 2015
6f8371b
MAGEDOC-1913. Get started on CLI
Feb 7, 2015
4f72fe5
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 7, 2015
c8bc288
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 7, 2015
cd1bd94
Test file for HTML
Feb 7, 2015
a9b1c42
Remove test file
Feb 7, 2015
d1c5cb0
MAGEDOC-1913. Separate CLI options into separate topics, add enbale/d…
Feb 8, 2015
02f09d1
Merge branch 'pubs23_MAGEDOC-1913' of github.corp.ebay.com:Magento/de…
Feb 8, 2015
653a485
Spell check install guide
Feb 8, 2015
80df7c6
MAGEDOC-1913. Edits to CLI subcommands
Feb 8, 2015
75b1506
Merge branch 'pubs23_MAGEDOC-1913' of github.corp.ebay.com:Magento/de…
Feb 8, 2015
7b2f59d
MAGEDOC-1913. First pass through adding more CLI subcommands and enab…
Feb 8, 2015
45ed715
MAGEDOC-1913. Proofreading
Feb 9, 2015
6ee88f9
magedoc-1616
Feb 9, 2015
b878e12
Merge branch 'pubs23_1616' of https://github.corp.ebay.com/Magento/de…
Feb 9, 2015
a77be87
Merge pull request #496 from Magento/pubs23_MAGEDOC-1913
Feb 9, 2015
4db7446
MAGEDOC-2076. Add files to a clean branch
Feb 9, 2015
8e7c6f9
Move create module topic
Feb 9, 2015
c4b56b2
MAGEDOC-1913. Proofreading
Feb 9, 2015
c486d05
Test for HTML
Feb 9, 2015
939fd19
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 9, 2015
0ae452f
Revert test file
Feb 9, 2015
a14964a
MAGEDOC-1913. Review comments on --force
Feb 9, 2015
ec40cb1
Merge pull request #497 from Magento/pubs23_MAGEDOC-1913
Feb 9, 2015
8394ad6
MAGEDOC-1913. Typo in deployment configuration
Feb 9, 2015
77121df
Merge pull request #498 from Magento/pubs23_MAGEDOC-1913
Feb 10, 2015
caef375
Improve sample data instructions by removing composer.json manual edit
Feb 10, 2015
3aec4e9
Minor edit to maintenance mode
Feb 10, 2015
93d8d7f
1616
Feb 10, 2015
678af1b
Added troubleshooting for 503 errors related to Apache 2.4
Feb 10, 2015
76a147e
Merge pull request #499 from Magento/pubs23_MAGEDOC-1913
Feb 10, 2015
66ca6ec
MAGEDOC-1913. Responding to review comments, minor edits
Feb 10, 2015
05b1279
Merge branch 'devdocs-23-m8' into pubs23_MAGEDOC-1913
Feb 10, 2015
46cccb1
Merge branch 'pubs23_MAGEDOC-1913' into devdocs-23-m8
Feb 10, 2015
7769647
Merge branch 'devdocs-23-m8' of github.corp.ebay.com:Magento/devdocs_…
Feb 10, 2015
b58f004
Make developer comments visible on internal site
Feb 10, 2015
6f54b64
Add references for mod_access_compat troubleshooting
Feb 10, 2015
e769105
MAGEDOC-1913. Review comments about dependencies
Feb 10, 2015
4dcac8c
MAGEDOC-1913. Separated deployment configuration to a menu-level topic
Feb 11, 2015
e25bc1d
Merge branch 'devdocs-23-m8' into pubs23_MAGEDOC-1913
Feb 11, 2015
759429f
1616
Feb 11, 2015
bf53ca0
1616 Templates chapter
Feb 11, 2015
692a6d1
MAGEDOC 2076 more content added, changed Apache versions
Feb 11, 2015
37c38e6
MAGEDOC-1913. Minor proofreading, fixed broken cross-refs
Feb 11, 2015
99718bb
MAGEDOC-2076 Added link to the minimal sample externsion, and a litt…
Feb 12, 2015
4d41f15
MAGEDOC-2076 more fixes and content
Feb 12, 2015
fab09ef
Merge branch 'develop' of https://github.corp.ebay.com/Magento/devdoc…
Feb 16, 2015
a57815f
MAGEDOC-1913. Updates to Magento update
Feb 17, 2015
ca76a98
Merge branch 'develop' of github.corp.ebay.com:Magento/devdocs_intern…
Feb 17, 2015
b079a25
MAGEDOC-2076 Final review edits for Create a Module topic
Feb 17, 2015
6b1649b
MAGEDOC-1913. Updated sample data, added the ability to enable and di…
Feb 18, 2015
d7c2943
Merge pull request #514 from Magento/pubs23_1616
Feb 18, 2015
1d1747a
Merge branch 'pubs23_MAGEDOC-2076' into develop
Feb 18, 2015
ae12a2b
Merge branch 'develop' of github.corp.ebay.com:Magento/devdocs_intern…
Feb 18, 2015
1f57eeb
Merge branch 'develop' into pubs23_MAGEDOC-1913-merge
Feb 18, 2015
fe1773f
Merge branch 'pubs23_MAGEDOC-1913-merge' into develop
Feb 18, 2015
875c799
Fixed formatting in create modules topic
Feb 18, 2015
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
10 changes: 10 additions & 0 deletions _includes/install/before-you-begin-cli.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<p>Before you begin, make sure that:</p>
<ol><li>Your system meets the requirements discussed in <a href="{{ site.gdeurl }}install-gde/system-requirements.html">Magento System Requirements</a>.</li>
<li>You completed all prerequisite tasks discussed in <a href="{{ site.gdeurl }}install-gde/prereq/prereq-overview.html">Prerequisites</a>.</li>
<li>You installed Composer and cloned the Magento GitHub repository as discussed in <a href="{{ site.gdeurl }}install-gde/install/composer-clone.html">Install Composer and clone the Magento GitHub repository</a>.</li>
<li>After you log in to the Magento server, switch to the web server user as discussed in <a href="{{ site.gdeurl }}install-gde/install/prepare-install.html#install-update-depend-apache">Switching to the Apache user</a>.</li></ol>

<div class="bs-callout bs-callout-info" id="info">
<span class="glyphicon-class">
<p>You must install Magento from its <code>setup</code> subdirectory.</p></span>
</div>
22 changes: 22 additions & 0 deletions _includes/install/enable-disable-modules.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<p>Magento enables you to enable or disable currently installed modules; in other words, any Magento-provided module or any third-party module you currently have installed.</p>
<p>Certain modules have dependencies on other modules, in which case you might not be able to enable or disable a module because it has dependencies on other modules. </p>
<p>In addition, there might be <em>conflicting</em> modules that cannot both be enabled at the same time.</p>
<p>Examples:</p>
<ul><li>Module A depends on Module B. You cannot disable Module B unless you first disable Module A.</li>
<li>Module A depends on Module B, both of which are disabled. You must enable module B before you can enable module A.</li>
<li>Module A conflicts with Module B. You can disable Module A and Module B, or you can disable either module but you <em>cannot</em> enable Module A and Module B at the same time.</li></ul>

<p>Dependencies and conflicts are declared in the <code>require</code> field in Magento's <code>composer.json</code> file for each module. Conflicts are declared in the <code>conflict</code> field in modules' <code>composer.json</code> files. We use that information to build a dependency graph:</p>
<ul><li><code>A->B</code> means module A depends on module B.</li>
<li>A <em>dependency chain</em> is the path from a module to another one. For example, if module A depends on module B and module B depends on module C, then the dependency chain is <code>A->B->C</code>.</li></ul>
<p>If you attempt to enable or disable a module that depends on other modules, the dependency graph displays in the error message.</p>
<div class="bs-callout bs-callout-info" id="info">
<span class="glyphicon-class">
<p>It's possible that module A's <code>composer.json</code> declares a conflict with module B but not vice versa.</p></span>
</div>

<p><em>Command line <a href="{{ site.gdeurl }}install-gde/install/install-cli-subcommands-enable.html">module enable or disable subcommand</a> only:</em> To force a module to be enabled or disabled regardless of its dependencies, use the optional <code>--force</code> argument.</p>

<div class="bs-callout bs-callout-warning">
<p>Using <code>--force</code> can disable your Magento store and cause problems accessing the Magento Admin.</p>
</div>
10 changes: 10 additions & 0 deletions _includes/install/first-steps-cli.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<p>First steps:</p>
<ol><li>Log in to the Magento server as, or <a href="{{ site.gdeurl }}install-gde/install/prepare-install.html#install-update-depend-apache">switch to</a>, the web server user.</li>
<li>Change to the following directory:<br>
<pre>cd &lt;your Magento install dir>/setup</pre>
Examples:
<ul><li>Ubuntu: <code>cd /var/www/magento2/setup</code></li>
<li>CentOS: <code>cd /var/www/html/magento2/setup</code></li>
</ul>
</li>
</ol>
2 changes: 1 addition & 1 deletion common/css/override.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ code {
p.q {
font-size: 15pt;
color: red;
display: none;
/* display: none; */
}
Binary file added common/images/create_template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/edg_new_module_dir_structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/email-logo-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/insert-variable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/templ_overview_code1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/templ_overview_code2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions guides/v1.0/architecture/modules/mod_and_areas.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ github_link: architecture/modules/mod_and_areas.md
<h2 id="m2arch-module-areas-overview"> Overview</h2>
Modules define which resources are visible and accessible in an area, as well as an area's behavior.

In Magento there are the following Areas:
In Magento there are the following areas:

* **Magento Admin** (adminhtml)
* **Storefront** (frontend)
Expand All @@ -26,7 +26,7 @@ You can enable or disable an area within a module. If this module is enabled, it
<p>No module should depend on another module's area.</p>
</div>

Magento uses areas to efficiently make web service calls, loading only the dependent code for that area. Examples of areas include the frontend (storefront), backend (adminhtml), and webapi (web services).
Magento uses areas to efficiently make web service calls, loading only the dependent code for that area.

The purpose of areas is efficiency. If you are invoking a REST web service call, for example, rather than load up all the code related to generating user HTML pages, there is a separate area (such as /rest) which loads code that knows only how to answer the REST call (and not generate HTML pages using layouts). Each area can have completely different code on how to process URLs and requests.

Expand Down
89 changes: 89 additions & 0 deletions guides/v1.0/config-guide/config/config-create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
layout: default
group: config-guide
subgroup: Magento configuration files
title: Create or extend configuration types
menu_title: Create or extend configuration types
menu_order: 10
github_link: config-guide/config/config-create.md
---


#### Contents

* <a href="#config-files-extend-create">Extend configuration types</a>
* <a href="#config-files-extend-create-create">Create configuration types</a>
* <a href="#config-files-validate">Validate a configuration type</a>

<h2 id="config-files-extend-create">Extend configuration types</h2>
To extend an existing configuration type, you need only create a configuration file in your module.

For example, to add an event observer, you create `app/etc/events.xml` and declare a new observer.

Because the event configuration type already exists in Magento, the loader and the `events.xsd` validating schema are already present and functional.

Your new `events.xml` is automatically collected from your module and merged with other `events.xml` files for other modules.

<h2 id="config-files-extend-create-create">Create configuration types</h2>
To create new configuration type, you must add at minimum:

* XML configuration files
* XSD validation schema
* A loader

For example, to introduce an adapter for a new search server that enables extensions to configure how its entities are indexed in that server, create:

* A loader.
* An XSD schema.
* Any other classes required for your new type to work.
* An appropriately named configuration file. For example, `search.xml`. This file is read and validated against your schema.

If other modules have a `search.xml` file, they are merged with your file when it loads.

To create a new configuration type, extend the `\Magento\Framework\Config\ReaderInterface`, which is <a href="{{ site.mage2000url }}lib/internal/Magento/Framework/Config/Reader/Filesystem.php" target="_blank">Magento\Framework\Config\Reader\Filesystem</a> to provide the following parameters:

* `$fileResolver`. Implements `\Magento\Framework\Config\FileResolverInterface`. This parameter lists the files containing the configurations of your custom type.
* `$converter`. Implements `\Magento\Framework\Config\ConverterInterface`. This parameter converts the XML into the internal array representation of the configurations.
* `$schemaLocator`. Implements `\Magento\Framework\Config/SchemaLocatorInterface`. This parameter provides the full path to file(s) containing schema(s) for validation of the individual and merged configuration files.</p>
* `$validationState`. Implements `\Magento\Framework\Config\ValidationStateInterface`. This parameter defines whether a configuration file should be validated.
* `$fileName`. Name of a configuration file. The Reader looks for the file names specified by this parameter in modules' `etc` directories.
* `$idAttributes`. Array of note attribute IDs.

For example, to merge the XML files:

array(
'</path/to/node>' => '<identifierAttributeName>',
'</path/to/other/node>' => '<identifierAttributeName>',
}

* `$defaultScope`. Defines the configuration scope to be read by default. The default value for this parameter is global scope.

After you customize `ReaderInterface`, you can use it to collect, merge, validate, and convert the configuration files to an internal array representation.

<h2 id="config-files-validate">Validate a configuration type</h2>

Each configuration file is validated against a schema specific to its configuration type. Example: events, which, in earlier Magento versions, were configured in `config.xml`, are now configured in `events.xml`.

Configuration files can be validated both before (optional) and after any merge of multiple files affecting the same configuration type. Unless the validation rules for the individual and merged files are identical, you should provide two schemas for validating the configuration files:

* Schema to validate an individual
* Schema to validate a merged file

New configuration files must be accompanied by XSD validation schemas. An XML configuration file and its XSD validation file must have the same name.

If you must use two XSD files for a single XML file, the names of the schemas should be recognizable and associated with the XML file.

If you have an `events.xml` file and a first `events.xsd` file, the XSD files for the merged `events.xml` file could be named `events_merged.xsd`.

To ensure validation of an XML file by appropriate XSD file, you must specify the relative path to the XSD file in the XML file. For example:

<config
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/ObjectManager/etc/config.xsd">

Your IDE can validate your configuration files at both runtime during development.

#### Related topics

* <a href="{{ site.gdeurl }}config-guide/config/config-php.html">Module configuration files</a>
* <a href="{{ site.gdeurl }}config-guide/config/config-php.html">Magento's deployment configuration, config.php</a>
Loading