[MOBY-dev] auto-updating documentation works fine (hourly); 'search' may be broken

Frank Gibbons francis_gibbons at hms.harvard.edu
Tue Jan 24 15:27:02 UTC 2006


Mark,

Can't speak for the javadoc, but updating the online API docs from CVS 
appears to work. I checked in a slight modification to one of the files at 
6pm yesterday. When I checked at 9pm that evening, the modification was 
visible on the website, so I think we can assume that it's being done 
hourly. Martin doesn't do things by halves, so I assume the rest is workign 
too - nice job, Martin. It would be useful if we could have a link on the 
website to the POD, which could also be auto-updated from CVS, so that 
potential future users could browse the perl documentation online, without 
having to check out the code and run perldoc on it.

I'll work on making the API documentation look more integrated into the 
website, and try to provide better navigation so that the various pages are 
easier to see/find.

On a related note, when I type "servicenotes" or "provision" into the 
search widget and hit the button, I get back "Error 404 - not found". In 
fact, I just realised that even searching for "MOBY" returns this - could 
the search utility possibly be mis-configured? Search would be a useful 
feature, particularly until we can get the docs more organised, but even 
afterwards too.

-Frank

At 05:41 PM 1/23/2006, you wrote:
>On Mon, 2006-01-23 at 17:38 -0500, Frank Gibbons wrote:
>
> > Mark, there's also the question of how the website gets updated. The best
> > way to do it in my view, would be to have the website updated nightly and
> > automatically to reflect the documentation (both from static HTML) for the
> > non-language-specific parts of the API, and also from the POD/javadoc in
> > the language-specific parts. Seems like it shouldn't be too hard to run it
> > from cron, nor take too long to run (perhaps we could even do it hourly,
> > instead of daily?).
>
>I think both of these things are being done hourly already... or??
>
>AFAIK Martin has a cron running that rebuilds the javadoc, and the same
>cron runs a script that does a CVS update of the general docuentation
>part of the site
>
>If this isn't working, let me know.
>
>M
>
>
>
>--
>--
>...his last words were 'Hey guys!  Watch this!'
>--
>Mark Wilkinson
>Asst. Professor
>Dept. of Medical Genetics
>University of British Columbia
>PI in Bioinformatics
>iCAPTURE Centre
>St. Paul's Hospital
>Rm. 166, 1081 Burrard St.
>Vancouver, BC, V6Z 1Y6
>tel: 604 682 2344 x62129
>fax: 604 806 9274
>
>"For most of this century we have viewed communications as a conduit,
>        a pipe between physical locations on the planet.
>What's happened now is that the conduit has become so big and interesting
>       that communication has become more than a conduit,
>        it has become a destination in its own right..."
>
>                 Paul Saffo - Director, Institute for the Future
>
>_______________________________________________
>MOBY-dev mailing list
>MOBY-dev at biomoby.org
>http://biomoby.org/mailman/listinfo/moby-dev

PhD, Computational Biologist,
Harvard Medical School BCMP/SGM-322, 250 Longwood Ave, Boston MA 02115, USA.
Tel: 617-432-3555       Fax: 
617-432-3557       http://llama.med.harvard.edu/~fgibbons 




More information about the MOBY-dev mailing list