drafts section of the juju docs

Mark Mims mark.mims at canonical.com
Wed Jun 20 20:26:56 UTC 2012

On 06/20/2012 01:18 PM, Gustavo Niemeyer wrote:
> Hey Mark,
> On Wed, Jun 20, 2012 at 3:01 PM, Mark Mims<mark.mims at canonical.com>  wrote:
>> Please separate the approval process for new features from the
>> documentation.
>> We're running the risk of mixing docs for implemented features with docs for
>> features that're wip.
>> A feature branch should have docs for that feature that don't land in the
>> release docs until that feature lands in trunk.
> Wasn't the docs branch separated from the juju code base?
they were, but perhaps it was a mistake in retrospect.  afaik, this 
separation was done to make it easier for charm-contributors to 
contribute to the documentation.  The docs we have are really tightly 
coupled to code.

>>   The approval/review process
>> for features is a totally separate problem.  Perhaps we can even remove the
>> drafts folder from the docs?
> -1 on that specific part. Drafts are work in progress by definition,
> and it's good to have a visible place with them.
> gustavo @ http://niemeyer.net

I'm asking if developers can "spec review" and subsequently develop 
against an entire branch instead of a file in the drafts folder in trunk

Here's the proposal:
- William pulls or is assigned a new feature-request from the bug list
- he branches trunk to create a feature branch
- he writes docs to spec the feature out (right in the path where it 
would live in once released on trunk)
- submits his _branch_ for a "spec review" process
- after approval of spec, he then develops the feature in this same branch
(at this point no docs about this feature have ever shown up anywhere 
but this feature branch)
- submits branch for code review
- upon approval, merges into trunk
- docs for this feature show up on the website

Mark Mims, Ph.D.
Canonical Ltd.
mark.mims at canonical.com

More information about the Juju mailing list