search

astorm / pestle

A collection of command line scripts for Magento 2 code generation, and a PHP module system for organizing command line scripts.
MIT License
533 stars 101 forks source link

Implement and Document magento2:generate:config-helper Command #394

Open astorm opened 5 years ago

astorm commented 5 years ago

We need documentation for the magento2:generate:config-helper command.

A skeleton entry for this command can be found in the docs/ folder. Use grep, ack, (or your search tool of choice), etc. to find the file where magento2:generate:config-helper should be documented. If you can't find this command, pick a file and/or ask about it in the comments below.

Documentation should include

  1. An example of an interactive invocation (no argument)
  2. An example of a an argument based invocation
  3. A basic explanation of what this command does ("adds a model to the system")
  4. An explanation of every possible file that might be created (Model/Thing.php, etc/frontend/someconfig.xml, etc)
  5. If you need use an example module name, use Pulsestorm_Pestle for consistency
  6. Links to existing documentation for the feature -- preference given to documents on alanstorm.com, but almost anywhere on the internet is appropriate, so long as the information is accurate.
  7. Leave the output from help in your docs -- include your new stuff below this

Once you've documented this feature, make a PR against the master branch of the astorm/pestle repository.

If you have any question please ask below, but also be bold. Documentation is an iterative process so it's better to take a first crack at something and then ask questions about what you have.

Also if you disagree with something above -- come at us. :) The seven guidlines above are just that -- guides. If you have a better idea we want to hear about it.

astorm commented 5 years ago

Turns out this is another ghost command that was never implement. Likely because it turns out there's not a clear single system for reading in and merging Magento 2 configuration because something something architects. Disconnecting from the milestone.