[Bioperl-l] Documentation in the Bioperl package

[Brian Osborne]

Hilmar,

MediaWiki supports such things as rollback based on date but it is not CVS
where an entire set of pages are tagged by version. It is also scriptable so
it may be possible to emulate this type of tagging by script, but I'm not
entirely sure (see WWW::Mediawiki::Client, Jason pointed this out to me).

So the simple answer is probably "no". But let's be honest: synchrony
between code and documentation wasn't achieved using the previous approach,
CVS, either. 

What Jason, Torsten, and I appreciated when adding content to this new site
was that it was relatively easy, our hope is that this approach will get
more people involved. The assumption is that more involvement will lead to
better documentation - Jason made this assumption when electing to move the
site to MediaWiki and I have to say that I completely agree with this
assumption.

Jason, any thoughts on this question? An interesting one...

Brian O.



On 2/3/06 6:11 PM, "Hilmar Lapp" <hlapp at gmx.net> wrote:

> Just to be sure, the wiki will be able to handle versions (releases)?
> (documentation and APIs may change between releases and hence a more
> recent doc page may not apply to an earlier release)
> 
>   -hilmar
> 
> On 2/3/06, Brian Osborne <osborne1 at optonline.net> wrote:
>> bioperl-l,
>> 
>> The recent work on the Bioperl Wiki moved much of the Bioperl documentation
>> online. Since we cannot maintain 2 locations for all of this we¹ll be
>> removing a number of files from the package, specifically:
>> 
>> biodatabases.pod
>> biodesign.pod
>> bioperl.pod
>> bioscripts.pod
>> doc/howto/*
>> doc/faq/*
>> FAQ
>> 
>> Rest assured that all of these files have been gone over in detail to make
>> sure that no important information was lost during the migration. All of
>> this will be replaced by a single file, such as ³README.docs², that explains
>> where all the documentation is. It¹s not entirely clear what will happen to
>> bptutorial.pl. Moving its content to different online locations is possible
>> but in this case we loose its functionality as a script.
>> 
>> Are there any comments or questions or concerns?
>> 
>> Brian O.
>> 
>> 
>> _______________________________________________
>> Bioperl-l mailing list
>> Bioperl-l at lists.open-bio.org
>> http://lists.open-bio.org/mailman/listinfo/bioperl-l
>> 
>> 
> 
> 
> --
> ----------------------------------------------------------
> : Hilmar Lapp -:- San Diego, CA -:- hlapp at gmx dot net :
> ----------------------------------------------------------
> 
> _______________________________________________
> Bioperl-l mailing list
> Bioperl-l at lists.open-bio.org
> http://lists.open-bio.org/mailman/listinfo/bioperl-l