Ember Guides Status Update

The road to Ember 2.0 has been long and rewarding: the community and team have invested in huge efforts to move Ember to a component-based architecture; we released a stable Ember Data; and we unified our development process with Ember CLI. All in all, we've made huge progress.

Unfortunately, our docs efforts haven’t kept up with all of those improvements. We know that many Ember users have been frustrated that they can't find the resources they need to take advantage of new features.

Over the next few releases, we'll be focusing on major improvements to the content of the Ember Guides and the process of landing new features so we don't fall behind again.

Upcoming releases

Here's what you can expect in the coming weeks and months:

Ember Data: Several of us are working hard to update the Models section of the Guides to properly document Ember Data in its stable form. This should be released imminently.

Ember 2.1: Several people are working on reviewing the Guides from beginning to end to improve the quality of the writing and make sure that all of the information is up to date. We aim to have this completed for the 2.1 release of the Guides.

Ember 2.2: A few contributors are writing an updated version of the tutorial that used to be at the beginning of the Guides. We aim to have the first version in the 2.2 release.

Better process

Until recently, the Ember Guides and API documentation were maintained by the same developers who wrote the code for Ember.js itself. As the burden has grown, the developers bringing you Ember have stopped being able to tackle both writing the code and documenting it. We've realized that we need a more pragmatic and structured approach to keeping the documentation up-to-date.

We’ve created a new Docs subteam to help drive the direction of the documentation and help make sure that new features always include documentation. It includes existing Ember core team members, along with fresh faces @locks and @michaelrkn. With extra bandwidth from members who are focused exclusively on documentation, we've already made great strides in improving the documentation and filling in missing pieces.

Additionally, the team has agreed that no new feature will land in a stable release of Ember without documentation and updates to relevant guides. We don’t want documentation to languish again.

Getting involved

Whether you're a new Ember dev or an old hand, there is lots of work that you can help out with:

To help other contributors stay productive, please keep your contributions and questions limited to issues that are not being worked on by other contributors, and avoid asking for status updates. If you're curious about the progress of the Guides, you can follow along on commits to the Guides repo and read the Docs team weekly meeting minutes.

Like all of Ember.js and its sister projects, the Guides are maintained by an all-volunteer team. Please take a moment to thank them online, buy them a beer at your local meetup, and best yet, chip in and help out yourself!

Thanks to Yehuda Katz and Leah Silber for reviewing the draft of this post.

comments powered by Disqus