How's our documentation looking?
clint at ubuntu.com
Wed Mar 14 07:10:20 UTC 2012
Excerpts from Kapil Thangavelu's message of Tue Mar 13 23:34:46 -0700 2012:
> Excerpts from Kapil Thangavelu's message of 2012-03-13 23:18:33 -0700:
> > Excerpts from Robbie Williamson's message of 2012-03-13 14:36:28 -0700:
> > > I was reading through a thread on the openstack list about the state of
> > > their documentation and it made me think that with all the recent
> > > changes we have had this cycle, are we up-to-date on our docs?
> > >
> > > A quick look through what we have now is showing a lot of
> > > inconsistencies and missing documented features. Is feature
> > > documentation a part of the code review/approve process? If not, should
> > > it be? Juju is kickass, but adoption will suffer a lot if our
> > > documentation can't educate new users on how to use it.
> > >
> > > Any thoughts on how we can get this sorted for the bits we ship in
> > > 12.04? Maybe a documentation day(s) after Beta 2 (March 29th)?
> > The documentation is getting bit-rotted outside of new specs of features being
> > implemented. I had hoped we'd get more community contributions by splitting the
> > docs out the of the codebase, but that hasn't happened. At this point i'm hoping
> > to take have the team work on the docs at the end of the cycle b4 the final
> > release. Some documentation cleanup days before then do sound good.
> > -kapil
> I've been sort of keen on seeing a through the web editing option to support
> direct user feedback. The best option i've seen to date to facilitate this is
> enabling disqus comments on the docs, but while they have great tools, it still
> needs management of the comments as they get incorporated.
Disqus, to me, would be a huge missed opportunity for juju to eat its
own dog food. There are quite a few open source systems that could
facilitate this and be wrapped around the online documentation. One of
these should be charmed and deployed using juju. :)
More information about the Juju