Thanks to visit codestin.com
Credit goes to github.com

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

Update mod_intro.md #1524

Merged
merged 3 commits into from
Nov 2, 2017
Merged

Update mod_intro.md #1524

merged 3 commits into from
Nov 2, 2017

Conversation

likemusic
Copy link
Contributor

Add - placeholder to module path. Use Customer Import/Export module instead of Customer module to show hyphen using in module name.

Add <type> - placeholder to module path. Use Customer Import/Export module instead of Customer module to show hyphen using in module name.
@@ -34,7 +34,7 @@ See <a href="{{page.baseurl}}architecture/archi_perspectives/components/modules/

## Where do modules live?

Modules typically live in the `vendor` directory of a Magento installation, in a directory with the following PSR-0 compliant format: `vendor/<vendor>/module-<module-mame>`. For example, the Customer module of Magento can be found at `vendor/magento/module-customer`.
Modules typically live in the `vendor` directory of a Magento installation, in a directory with the following PSR-0 compliant format: `vendor/<vendor>/<type>-<module-mame>`. For example, the Customer Import/Export module of Magento can be found at `vendor/magento/module-customer-import-export`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<module-mame> should be <module-name>

Also, why replace module with <type>? Doesn't this contradict Magento's module naming convention?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<type> can be one of values:

  • "module" - for modules (module-customer-import-export);
  • "theme" - for front and admin themes (theme-frontend-luma);
  • "language" - for language packs (language-de_de);

May be add this info to doc?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! You're absolutely right. Sorry, I was too focused on the word "module". Yes, I think it would be beneficial to add these to the docs as well. Do you mind adding them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ок, I'll add this info to doc.

@jeff-matthews jeff-matthews self-assigned this Nov 2, 2017
Add module type description.
@likemusic
Copy link
Contributor Author

Info about module types added. But I have not good English level, therefore you can check it and fix before merging :)

@jeff-matthews jeff-matthews merged commit dcadf49 into magento:develop Nov 2, 2017
@jeff-matthews
Copy link
Contributor

Thanks @likemusic!

magento-cicd2 pushed a commit that referenced this pull request Dec 6, 2017
Changed Technical Guidelines to be version specific
@likemusic likemusic deleted the patch-19 branch May 7, 2018 22:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants