Hi Robert, Regarding documentation... For now I'd like to leave it as is... In the future, we'll likely need something better - whatever that might be. One of the problems that most projects run into is that each version of the software needs slightly different documentation, and it's frustrating to read docs that don't match the version you have installed. With this method, we will always deliver documentation that matches the code.
One nice thing about putting the documentation into the same source tree as the code, is that the two will always go together. For any version of the source we have built, we will also be able to host documentation that matches that version. Of course, that presents its own challenges... My next step on documentation will likely to take advantage of more of Doxygen's capabilities to customize the site some more. As we begin to reach the point of diminishing returns in terms of Doxygen, that's a good time to look for something better. But right now, we don't have much documentation to worry about ;-) Writing it and maintaining it is much more of a problem than hosting it in my experience. I've done some really cool things in the past, but for now, until we get a Docmaster or a Webmaster who has time to own this, the less effort to maintain it the better. Robert Holder wrote (via Google+) > i don't know if you have any interest in this, and you seem to already > have your docs website thing figured out... doxygen based thingy, it > looks like. i was using something called helpndoc, which turned out > to have problems. then i ended up using "google sites" page hosting > service. > > It worked very well for our online documentation, and made our > documentation much easier to create and maintain. I've used various > flavors of wikis before, but there are admin issues that need to be > stayed on top of, and my wiki ended up getting hijacked by stupid > viagra hucksters and so on because I didn't configure it properly. i > don't want to have to become a wiki expert, so google sites turned out > well for us. it may not be what you are interested in, but here is an > example of what can be done with it from our (now defunct) project: > > feetwetcoding <https://sites.google.com/site/feetwetcoding/> > > also the "google code" stuff is cool, and free. it is not as fancy as > atlassian, but it did what we needed, again an example from our little > project: > > http://code.google.com/p/feetwetcoding/issues/list > > thought you might be interested in checking these out if you hadn't > seen them. if you already knew all about them, or just aren't > interested, my apologies! :-)?
_______________________________________________ Assimilation mailing list - Discovery-Driven Monitoring [email protected] http://lists.community.tummy.com/cgi-bin/mailman/listinfo/assimilation http://assimmon.org/
