Devdocs: Configuration object topic

Created on 27 Nov 2018  路  10Comments  路  Source: magento/devdocs

New topic request

Description

As a developer, I want to understand how to "use the classes described in Overview of Module Configuration to create a configuration object for a new system wide foo.xml. In addition to solving a specific problem (how do I add new global/frontend/adminhtml configuration file to the system) the existence of this article would also allow developers to infer how they could read from the other configuration files."

Content checklist

  • [ ] How to use the classes described in Overview of Module Configuration to create a configuration object for a new system wide foo.xml
  • [ ] How to read from the merged configuration tree
  • [ ] How to use classes from the existing configuration class hierarchy to read custom configuration files

Additional information/resources

StackExchange: http://magento.stackexchange.com/questions/82022/magento-2-how-to-read-from-configuration-tree

Related JIRA ticket: MAGEDOC-2582

Related GitHub issues:

  • #470
  • #453
Contribution Day Help Wanted New Topic PR created good first issue Special achievement

All 10 comments

Hey guys I am looking into this issue could you please assign this to me?

@diazwatson It's yours.

Thanks @keharper 馃憤

@diazwatson Are you still interested in working on this new topic?

Hi @meker12 apologies for the delay. I will submit a PR in the next few hours

I finally started working in this (apologies for the delay) and I have some doubts you guys maybe could give me a hand with?

  1. do you guys think is better to use generic names like Vendor\ModuleName in the examples or refer to the core files?
    Putting myself in the shoes of a developer that lands to this topic looking for answers that help his/her develops a module I can see benefits in both approaches.

  2. Module configuration files is a big section and therefore I think it would make more sense to create a separated topic for this. But at the same time I have not seen any other HowTo topic under Configuration Guide so I am not sure what would be the best place to put this topic

Thanks in advance

do you guys think is better to use generic names like Vendor\ModuleName in the examples or refer to the core files?
Putting myself in the shoes of a developer that lands to this topic looking for answers that help his/her develops a module I can see benefits in both approaches.

I would go with the generic name as the primary example and then link/refer to core files for any additional information needed.

Module configuration files is a big section and therefore I think it would make more sense to create a separated topic for this. But at the same time I have not seen any other HowTo topic under Configuration Guide so I am not sure what would be the best place to put this topic

I agree with creating a separate topic for this issue. My recommendation would be to put it under the Module configuration files topic.

Thanks @jcalcaben

Contributors! See the above closed PR for the work. Clean it up, submit, call it good!

Let's try with this one - https://github.com/magento/devdocs/pull/6514. It's based on @diazwatson PR and contains @rogyar notices.

Thanks

Was this page helpful?
0 / 5 - 0 ratings