Re: Make documentation part of new features acceptance criteria?

2013-07-11 Thread Cosmin Lehene
I like the release criteria idea. Perhaps add them to coding guide or the developer section on wiki? WRT feature completeness, I didn't think about having a doc for each one, but rather updating the existing doc or the CHANGES.txt file (we don't have one yet) with a note when adding new

Re: Make documentation part of new features acceptance criteria?

2013-07-11 Thread Jay Kreps
Cool, let's do that then. I think we will likely be in a better state in a week--Sriram is working on updating the design page which is the last big outstanding thing that is out of date. I do totally love the hbase documentation, they are doing it right. -Jay On Thu, Jul 11, 2013 at 2:47 AM,

Make documentation part of new features acceptance criteria?

2013-07-10 Thread Cosmin Lehene
I'm not sure if there's already a guideline like this, but I wouldn't it make sense to have it in order to keep documentation in sync with the code? Also, having this type of documentation as part of the codebase to allow proper versioning might be a good idea as well. Cosmin

Re: Make documentation part of new features acceptance criteria?

2013-07-10 Thread Jun Rao
Cosmin, That's a good idea. In the past, for major new features, we tend to create a wiki page to outline the design. The wiki pages can be organized better. Is this what you are looking for? Thanks, Jun On Wed, Jul 10, 2013 at 1:17 AM, Cosmin Lehene cleh...@adobe.com wrote: I'm not sure if

Re: Make documentation part of new features acceptance criteria?

2013-07-10 Thread Jay Kreps
I like the idea of improving our documentation. Help is very much appreciated in this area (but of course the problem is that the people who experience the holes almost by definition can't fill them in). So even just pointing out areas that aren't covered is really helpful. We are in a sort of