Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Contributing to Meteor Documentation

DZone's Guide to

Contributing to Meteor Documentation

If you’ve been developing in Meteor, you may have noticed we recently launched a brand-new, shiny design for our documentation and guide sites.

· Web Dev Zone
Free Resource

Learn how to build modern digital experience apps with Crafter CMS. Download this eBook now. Brought to you in partnership with Crafter Software

If you’ve been developing in Meteor, you may have noticed we recently launched a brand-new, shiny design for our documentation and guide sites.

s_B137D705D1A67D4E9CB9356E16CFF72389B2DA3EB9A61E18B6A2F90BC196036D_1463612765920_Screenshot2016-05-1816.05.53.png

Apart from being easy on the eyes (and infinitely more discoverable by Google search) the new docs site was created with the principal aim of being easier to contribute to. You’ll notice a prominent “edit on GitHub” link on each page, which you can use to send fixes to documentation content or suggest improvements.

Documenting in the Open

Meteor has had a long history of enabling and welcoming documentation from community contributors. I myself co-wrote the book Discover Meteor before I had even joined the Meteor team. Meteor’s first tutorial was also open-sourced on GitHub and welcomed pull requests for anyone who found bugs or typos.

We carried this tradition over into our development of the Meteor Guide. In my Meteor Night talk last month, I spoke about the incredible success we’ve had creating the Guide in the open with the full collaboration of the community, and how we’ve seen some amazing community contributors step up as a result .

New Roles for Docs Contributors

To recognize those efforts, we’ve created a new way for the most dedicated docs contributors to get involved. One contributor, in particular, Loren Sands-Ramshaw has volunteered to become a maintainer of our documentation—this title is both to highlight the great contributions he was making before and to enable him to increase his involvement in the process of crafting our guide and other documentation.

We’d like to take this opportunity to publicly thank Loren and encourage more folks to make larger contributions. With that in mind, we’ve published an initial set of community guidelines for Meteor documentation contributions. If you’re interested to find out what it takes to become a documentation maintainer, we encourage you to read the document and let us know if you have suggestions for how we can improve our process.

We really hope we can build on the powerful community momentum we have behind the Guide and extend it to more and more parts of the Meteor framework to make it the best possible platform for the community.

Crafter is a modern CMS platform for building modern websites and content-rich digital experiences. Download this eBook now. Brought to you in partnership with Crafter Software.

Topics:
meteor ,documentation

Published at DZone with permission of Tom Coleman, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

THE DZONE NEWSLETTER

Dev Resources & Solutions Straight to Your Inbox

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

X

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}