Suggested topics for contribution

Our goal is to provide the Magento community with comprehensive and quality technical documentation. We believe that to accomplish that goal we need developer experts from the community to contribute to the documentation.

If you are interested in working on one of these projects, open a pull request on this page. You can also email us at DL-Magento-Doc-Feedback@magento.com, chat with us at Community Engineering Slack channel , or post a comment in the GitHub issue linked to the project title.

The following GitHub issues are a great place to start:

If you take the issue and provide a PR to resolve it, make sure to add the link to the issue in the description. You can earn Contribution Points for every submitted to and merged into DevDocs.

All of the following suggestions come directly from the community.

Project Size Requirements Contributor
Menu widgets Small

Help us improve the Menu widget topic by contributing working code samples and better descriptions of menu options.

Acceptance criteria:

  • Sample code showing the use of the menu widget.
  • Sample code showing the use of other widgets that are not documented, including dropdowndialog and list.
Admin grids Small

Help us improve DevDocs by creating a new topic that explains how to create a grid in the Admin interface.

Acceptance criteria:

  • New content must be in the form of a tutorial or how-to.
  • New content must list the steps needed to create a simple Admin grid.
  • New content must contain working code samples with explanations.
Price adjustments Medium

Help us improve DevDocs by creating a new topic about price adjustments.

Acceptance criteria:

  • Describe how priced adjustments work.
  • Describe what areas price adjustments affect.
Category attributes Medium

Help us improve the How to add a category attribute topic by providing details about how to extend attributes.

Acceptance criteria:

  • Provide an extended explanation of the parameters (key => value) for the addAttribute function.

    For example, 'type' => 'int' and a list of all possible keys and their corresponding possible values.

  • Provide an extended explanation of the XML tags inside the tag. For example:
    • What basic structure should always be applied?
    • What inner tags should be added depending on the type of attribute being added?
    • What values and attributes should these tags include?
Logging Large

Help us improve the Custom logging topic by adding more details and examples.

Acceptance criteria:

  • Describe what you can do with Magento's stock logger implementation and when you should extend it or implement your own.
  • Explain how to log a message to the system.log file.
  • Explain how to log a message to a custom log file.
  • Provide working sample code for each of the scenarios listed in the topic, including what code to run and where to look in the file system for the log message:
    • Log to files and syslog
    • Send alerts and emails
    • Log specific servers and networked logging
    • Logging in development
  • Differentiate between versions of Magento, if applicable.