drafts section of the juju docs
Gary Poster
gary.poster at canonical.com
Wed Jun 20 19:38:21 UTC 2012
On 06/20/2012 03: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?
>
>> 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.
>From the peanut gallery/from a user perspective: I can see that it is
nice to have them visible, but having them in the same location is
confusing.
In particular, recently I wanted to read about subordinate charms. I
searched for them.
https://www.google.com/search?sourceid=chrome&ie=UTF-8&q=juju+subordinate+charms
The first link for me, then and now, is this page:
https://juju.ubuntu.com/docs/drafts/subordinate-services.html
I was confused: I thought this feature was released! And other similar
thoughts.
Eventually, I clicked on the table of contents, and found
https://juju.ubuntu.com/docs/subordinate-services.html .
While arguably this is SEO, I'd guess that it's related, and that having
drafts away from the main juju.ubuntu.com site would help this sort of
scenario.
Thanks
Gary
More information about the Juju
mailing list