From 9a76ba59275b943b9c42ad34b9c6c018a0f9a85e Mon Sep 17 00:00:00 2001 From: T Dobbs Date: Fri, 26 Jun 2015 14:44:33 -0500 Subject: [PATCH] New draft of introduction to PHP Developer's Guide. You know you can't wait to read it. For perspective on the new introduction please see the updated outline on the Magento wiki --- Gemfile | 2 +- Gemfile.lock | 2 + .../extension-dev-guide/Contribute_edg.md | 6 +- .../build_a_simple_module.md | 14 +++++ .../v1.0/extension-dev-guide/introduction.md | 59 +++++++++++++++++++ guides/v1.0/extension-dev-guide/worksheet.md | 12 ++++ guides/v1.0/template.md | 2 +- 7 files changed, 92 insertions(+), 5 deletions(-) create mode 100644 guides/v1.0/extension-dev-guide/build_a_simple_module.md create mode 100644 guides/v1.0/extension-dev-guide/introduction.md create mode 100644 guides/v1.0/extension-dev-guide/worksheet.md diff --git a/Gemfile b/Gemfile index 6bb9eb91db3..8ca5fdb8684 100644 --- a/Gemfile +++ b/Gemfile @@ -1,2 +1,2 @@ gem 'github-pages' -source 'https://rubygems.org' +source 'https://rubygems.org' \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 82d0e67441b..b7678d51878 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -130,3 +130,5 @@ PLATFORMS DEPENDENCIES github-pages + + diff --git a/guides/v1.0/extension-dev-guide/Contribute_edg.md b/guides/v1.0/extension-dev-guide/Contribute_edg.md index cfac5863ceb..bff71984f09 100644 --- a/guides/v1.0/extension-dev-guide/Contribute_edg.md +++ b/guides/v1.0/extension-dev-guide/Contribute_edg.md @@ -1,10 +1,10 @@ --- layout: default -group: extension-dev-guide -subgroup: A_Introduction +group: Contributor Guide +subgroup: title: Contribute to Magento DevDocs! menu_title: Contribute to Magento DevDocs! -menu_order: 1 +menu_order: 100 --- diff --git a/guides/v1.0/extension-dev-guide/build_a_simple_module.md b/guides/v1.0/extension-dev-guide/build_a_simple_module.md new file mode 100644 index 00000000000..bb1745717f7 --- /dev/null +++ b/guides/v1.0/extension-dev-guide/build_a_simple_module.md @@ -0,0 +1,14 @@ +--- +layout: default +group: +subgroup: +title: PHP Developer Guide Build A Simple Module +menu_title: Build a Module +menu_order: 1 +github_link: extension-dev-guide/build_a_simple_module.md + +--- + + + +build_a_simple_module \ No newline at end of file diff --git a/guides/v1.0/extension-dev-guide/introduction.md b/guides/v1.0/extension-dev-guide/introduction.md new file mode 100644 index 00000000000..8299289f3b3 --- /dev/null +++ b/guides/v1.0/extension-dev-guide/introduction.md @@ -0,0 +1,59 @@ +--- +layout: default +group: +subgroup: +title: PHP Developer Guide Introduction +menu_title: Introduction +menu_order: 1 +github_link: extension-dev-guide/introduction.md + +--- + + +##Introduction + +This guide is for developers that need to modify or customize an existing Magento module, or are building a new module from scratch either for custom extension of Magento functionality. This guide is also for those who want to create an extension for Magento Connect, although it does not cover the publishing process. + + +##Magento is made up of components: + +* Modules +* Libraries +* Themes +* Language packages + + +A Magento **module** is a discrete chunk of code that accomplishes a particular business function or handles a Magento feature. They are typically a collection .php and .xml files, and the bulk of your work in modules will be in these files. Modules are interactive with each other. A module also contains the user interface required for a user’s interaction with the module. Themes can be applied to the module to change its appearance. So when you are building a module, you may also touch themes and language packs. + +A **package** is a module that is wrapped up in a distributable form. Usually you will use Composer to do this. This can be released on + +An **extension** is a module that is packaged for sale on Connect. + + +
+

You must follow a PSR compliant structure when building a module.

+
+ + +##Magento module example + +At the very minimum, a Magento module could simply be an XML file: + + + + + + + + + +##What's Next? + +Get your feet wet quickly and build a simple Magento module. + +Or jump right away into your eyeballs and use a worksheet that steps you through a complete best practice method to build, test, and package a Magento module. + diff --git a/guides/v1.0/extension-dev-guide/worksheet.md b/guides/v1.0/extension-dev-guide/worksheet.md new file mode 100644 index 00000000000..d2fea610f80 --- /dev/null +++ b/guides/v1.0/extension-dev-guide/worksheet.md @@ -0,0 +1,12 @@ +--- +layout: default +group: +subgroup: +title: PHP Developer Guide Module Worksheet +menu_title: Module Worksheet +menu_order: 1 +github_link: extension-dev-guide/build_a_simple_module.md + +--- + +#Module Worksheet \ No newline at end of file diff --git a/guides/v1.0/template.md b/guides/v1.0/template.md index d18ebe1de17..a52f0336c84 100644 --- a/guides/v1.0/template.md +++ b/guides/v1.0/template.md @@ -1,6 +1,6 @@ --- layout: default -group: extension-dev-guide +group: subgroup: A_Introduction title: template (generic) menu_title: template (generic)