Contributor Tutorial

This series of tutorials is designed to help community members and vendors of bundled extensions (VBEs) contribute to the Magento documentation in the merchdocs repository. Although many contributors prefer to work from the command line, this tutorial shows how to use GitHub Desktop, Visual Studio Code, and Markdown. The instructions are written so that even those without previous experience can help keep the documentation up to date. In addition to the basics, this tutorial covers best practices, conventions, and procedures that everyone who works in the merchdocs repository needs to know.

A note for those who also work in the devdocs repository: The merchdocs and devdocs repositories evolved separately and have different levels of complexity. Although they are similar, sometimes there's a slight difference in syntax and rules. We make note whenever the requirements differ between the two.

For VBEs: The Magento User Guide walks merchants through the onboarding process for each bundled extension. In addition, there is at least one topic in the Configuration Reference with screenshots and field descriptions for each configuration section that is related to the extension. After explaining the initial onboarding and configuration process, the User Guide links to the extension vendor site for further documentation.

Contents

Part 1: Get Started with GitHub Desktop

Part 2: Bullets, Links, and Headings

Part 3: Images, Numbered Lists, and Tables

Part 4: Navigation and Publishing Process