Re: Experimenting with migrating wiki to GitHub pages

Peter Cock <[email protected]>
Newsgroups gmane.comp.python.bio.devel
Message-ID <CAKVJ-_6t8Z6YCdLV2Laz1+utYAQbzHnESXDDabH3k4ERTuv+Fw@mail.gmail.com>
On Sun, Apr 10, 2016 at 8:22 PM, Peter Cock <[email protected]> wrote:
> Both BioPerl.org and BioJava.org are now pointing at
> GitHub Pages sites.
>
> On Fri, Apr 8, 2016 at 11:10 PM, Peter Cock <[email protected]> wrote:
>>
>> Yes - I'm also hoping to switch biopython.org to the GitHub
>> pages version ASAP (and we the OBF need to write a blog
>> post about this too):
>>
>> https://github.com/biopython/biopython.github.io
>> http://biopython.github.io/wiki/Biopython
>>
>> I made some progress on the migration, and will tackle the
>> category pages next,
>
> That's working now, meaning most of the content is usable.
> There are other minor issues, but as far as I can tell, nothing
> we couldn't fix after making the switch to GitHub pages live.
>
> https://github.com/biopython/biopython.github.io/issues
>
> Please do have a look round the conversion to see if you
> can spot any problems with it, relevant pages:
>
> http://biopython.github.io/wiki/Biopython
> http://biopython.github.io/wiki/Download
> http://biopython.github.io/wiki/Mailing_lists
> http://biopython.github.io/wiki/Documentation
> http://biopython.github.io/wiki/Category:Cookbook
> http://biopython.github.io/wiki/SourceCode
> http://biopython.github.io/wiki/Participants
> http://biopython.github.io/wiki/Scriptcentral
>
>> then "borrow" some of Andreas' styling
>> work as showcased on the (now live) http://biojava.org site.
>
> This is where I am most hoping for help, tracking issue:
> https://github.com/biopython/biopython.github.io/issues/3

Markus has been working on this - thank you!

>> Adding the static API documentation pages should be easy,

Done, live at

http://biopython.github.io/DIST/docs/api/
https://github.com/biopython/biopython.github.io/tree/master/DIST/docs/api

>> the old release might be more trouble if there are any hosting
>> or file size limits we might hit...

I have imported the tutorial etc, under the docs folder:

http://biopython.github.io/DIST/docs/ (currently 404 error)
https://github.com/biopython/biopython.github.io/tree/master/DIST/docs

If you know the URL, you can link directly to existing files, e.g.
the BOSC 2003 talk which Brad gave featuring many of the other
candidate logos for Biopython:

https://biopython.github.io/DIST/docs/presentations/bosc_biopython.pdf
https://github.com/biopython/biopython.github.io/blob/master/DIST/docs/presentations/bosc_biopython.pdf

It ought to be simple to add file listings to these folder with Jekyll...

> On a related point, I don't think there is much point having a
> snapshot of the code under the /SRC/ folder - the only reason
> I've used it have been for a simple HTTP link to test files or the
> licence. I think we can put a place holder page up directing
> people to GitHub instead?

Done:

https://github.com/biopython/biopython.github.io/tree/master/SRC
http://biopython.github.io/SRC/

Curiously GitHub Pages with Jekyll 3.0 hasn't automatically made
"naked" URLs into links - this looks like a regression from GitHub
switching to kramdown, simplest fix is wrapping the URL as <URL>
instead.

http://hakanu.net/markdown/2016/03/22/switched-to-redcarpet-instead-of-kramdown-as-markdown-renderer/

Peter
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.