[Opensim-dev] Tracking Documentation in Mantis

[Rob Smart]

On Thu, Oct 2, 2008 at 11:19 PM, Sean Dague <sdague at gmail.com> wrote:

> Rob Smart wrote:
> > Random suggestion here ... anyone think it would be a good/bad idea to
> track
> > documentation on Mantis ?
> >
> > By this I mean create a Mantis category for documentation, then people
> can
> > submit a bug report on there if they can't find enough info about
> something
> > they need.
> >
> > Then we can use Mantis to track the state of the docs too, plus people
> can
> > raise defects against out of date/incorrect docs in a more visible way.
>
> You over estimate how visible stuff in mantis is. :)


Hehe point taken...
however, it is more visible and manageable than the wiki simply for the fact
that new bug entries and fixed bug entries get posted in multiple locations.
IRC and Twitter for a start.

There's also the recognition bonus for none code contributors i.e.  "So and
So added some useful documentation about X" seeing documentation updates
like that might make other IRC/Twitter
listeners more inclined t goa nd look at the new entries or contrbute their
own..


>
>
> >
> > Thoughts ?
>
> Do you mean for documentation in code, or in the wiki?  If it's for the
> code, I think mantis is appropriate.  If it's in the wiki I think there
> are better ways to do that.
>

I meant documentation in the wiki. I'm open to suggestions of how to better
track and request entries/changes on the wiki. However at the moment i feel
documentation is lacking currently
and bringing the request/recognition mechanisms inline with those for code
contribution may help.

The problem  with normal wiki usage is that yes you can add comments on the
comment pages but someone has to actively go and look for them. rather than
doing a quick priority sort on documentation
in Mantis, plus the IRC updates help give peripheral vision of  updates
occuring.


> We just started using macros in the wiki like {{obsolete}} and
> {{content}} that help to tag parts of the wiki that need work.  I owe a
> structural guideline for the wiki as well.
>
> It also turns out that because the template is so changed from the media
> wiki default a lot of people didn't realize opensimulator.org was
> actually a wiki, and that they could edit it.  I'm going to craft a new
> opensim theme that keeps the color scheme, and some of the graphics, but
> makes the layout look more like monobook in the hope that this helps get
> more people to participate.
>
>        -Sean
>
> --
> Sean Dague / Neas Bade
> sdague at gmail.com
> http://dague.net
>
>
>
> _______________________________________________
> Opensim-dev mailing list
> Opensim-dev at lists.berlios.de
> https://lists.berlios.de/mailman/listinfo/opensim-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://opensimulator.org/pipermail/opensim-dev/attachments/20081002/bfd02f57/attachment-0001.html>