Publish Warcbase wiki as gitbook (decided on MKDocs instead)

[lintool]

@aliceranzhou @ianmilligan1 @jrwiebe I've been looking at Gitbook recently. It supports the creation of slick-looking books, e.g., Databricks Spark Reference Applications, all in markdown format.

What do you think about porting the Warcbase wiki over to a Gitbook?

[ianmilligan1]

Looks good to me, and far more intuitive than a GitHub wiki.

My only fear is the long-term sustainability of the Gitbook platform, but presumably we can just yank all the markdown out and host it elsewhere if need be.

[lintool]

Yes, I thought about potential lock-in, but the nice thing is that it's still a Git repo and still markdown, so I don't see any real danger here.

[lintool]

Hi all, check this out: https://www.gitbook.com/book/lintool/analyzing-web-archives-with-warcbase/details

What do you think?

It's being automatically generated from here: https://github.com/lintool/warcbase-docs

[jrwiebe]

I still like the wiki, but that's probably just my status quo bias. I think the main advantage of the Github is that it requires the documentation to be put in some kind of order, which should be helpful to users, especially as we add more pages to the wiki. I wouldn't object if we switched.

[ianmilligan1]

On separate thread, @ruebot is exploring MKDocs.

@lintool, can you add me as a contributor to "warcbase-docs"? Thanks!

[lintool]

@aliceranzhou @ianmilligan1 @jrwiebe @ruebot all added as contributors to https://github.com/lintool/warcbase-docs/

[ianmilligan1]

It's looking good:

http://lintool.github.io/warcbase-docs/

Could we get http://warcbase.org/ to point to the documentation? We could then put a big download button on the front page too. Landing on a GitHub repository could turn off some users.

[lintool]

Landing on a GitHub repository could turn off some users.

pssssht. they can handle it :)

Are we good on this, switching over to MKDocs? If so, I'll archive the current wiki and then axe it.

[ianmilligan1]

Aye, let's greenlight the formal switch over to MKDocs. I've updated the Spark Link Analysis script today based on @aliceranzhou's revisions, so we should be properly synced.

[aliceranzhou]

+1. Thanks Nick for setting it up, and Prof. Ian for syncing!

On Thu, Dec 3, 2015 at 1:18 PM Ian Milligan notifications@github.com wrote:

Aye, let's greenlight the formal switch over to MKDocs. I've updated the Spark Link Analysis script today based on @aliceranzhou https://github.com/aliceranzhou's revisions, so we should be properly synced.

— Reply to this email directly or view it on GitHub https://github.com/lintool/warcbase/issues/181#issuecomment-161737127.

[lintool]

I've disabled the wiki, contents archived to https://github.com/lintool/warcbase-wiki

[lintool]

Documentation links in README are broken. I'm fixing now.

[lintool]

Everything seems to be in order. Closing ticket.