[BioRuby] Tutorial situation

[Jan Aerts]

GitHub is not a bad option, but I'm afraid a github-page would be yet
another "homepage for bioruby", which is something we really should avoid.

How about we (let someone) write the tutorials in a "tutorials" subdirectory
of bioruby (so it's kept under version control) but actually show those
tutorials on the existing bioruby homepage (http://bioruby.open-bio.org).

I don't care what formatting would be used for the tutorials, but my vote
goes for Textile.

jan.

2009/2/25 Michael Barton <mail at michaelbarton.me.uk>

> GitHub pages is one option.
> The documentation is kept in an empty branch of the git source code; Github
> automatically converts the code into HTML which is which would be hosted at
> bioruby.github.com. The CNAME can be updated though, which means any url
> could be used.
>
> More info at:
> http://github.com/blog/272-github-pages
>
> Cheers
>
> Mike
>
> 2009/2/25 Pjotr Prins <pjotr.public14 at thebird.nl>
>
> > Thanks everyone, and Naohisa in particular, for the new release!
> >
> > I would like discuss the Tutorial situation. Currently we have a
> > wiki, which is updated by people, and a Tutorial.rd in the source
> > tree. They are not in sync.
> >
> > I like the .rd version as it is a generator and I can use it for
> > automated testing of the embedded source code - so we know the docs
> > are up-to-date. On the other hand, the wiki is nice since it is proven
> > to get updates from occasional users.
> >
> > The tutorial is a much used resource for introducing BioRuby. I
> > think we need a solution to synchronize them.
> >
> > One option is to generate .rd from mediawiki - that would allow quick
> > diffing. But there is no such tool.
> >
> > One we have one source I am happy to update the tutorial again.
> >
> > Any ideas for a resolution?
> >
> > Pj.
> >
> >
> > _______________________________________________
> > BioRuby mailing list
> > BioRuby at lists.open-bio.org
> > http://lists.open-bio.org/mailman/listinfo/bioruby
> >
> _______________________________________________
> BioRuby mailing list
> BioRuby at lists.open-bio.org
> http://lists.open-bio.org/mailman/listinfo/bioruby
>