URL for Warcbase Docs

[ianmilligan1]

Stemming from a discussion with @jrwiebe - could we change our doc URL from http://lintool.github.io/warcbase-docs/ to http://warcbase.org/docs? This would enhance usability and make an easier URL to share in slidedecks, etc.

Will paste notes from Jeremy below.

[ianmilligan1]

From @jrwiebe:

This is one way to do it:

1. In the gh-pages branch of warcbase docs, add a file called CNAME containing docs.warcbase.org. (Or whatever)
2. Add a CNAME record to warcbase.org that points to lintool.github.io. Now when a person visits http://docs.warcbase.org/ it redirects to http://lintool.github.io/warcbase-docs/ References: https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/ and https://help.github.com/articles/adding-a-cname-file-to-your-repository/

[jrwiebe]

With Github custom domains what you propose, @ianmilligan1, wouldn't quite work. We can only point a domain record (CNAME or A) to a repo, not a directory off the domain. So http://warcbase.org/docs -> http://lintool.github.io/warcbase-docs/ wouldn't work, but http://warcbase.org/ -> http://lintool.github.io/warcbase-docs/ would. I would find this acceptable. Of course we could have a prominent link at warcbase.org/index.html to the main warcbase repo.

[lintool]

I've played with domain forwarding so that http://docs.warcbase.org/ now works*. Will that do?

• It works for me now, but due to DNS propagation delays it might take some time to work...

[ianmilligan1]

Works for me as well - I think this is great. It's a much easier URL to share.

[jrwiebe]

It works, but it would be better if you could create a CNAME to lintool.github.io, and then add a CNAME file to the root of the repo under the gh-pages branch, containing the text "docs.warcbase.org". Then when you visit the site the warcbase domain would show up in the URL bar.