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.
Join the DZone community and get the full member experience.
Join For FreeIf you’ve been developing in Meteor, you may have noticed we recently launched a brand-new, shiny design for our documentation and guide sites.
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.
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.
Comments