Jupyter-book: Move Jupyter Book's documentation to jupyterbook.org ?

Created on 25 Sep 2019  路  5Comments  路  Source: executablebooks/jupyter-book

Currently, the Jupyter Book documentation exists at jupyter.org/jupyter-book . This is being served from GH-pages off of the main Jupyter account.

In #342 we discussed using Netlify to build previews for Jupyter Book, as well as the ability to host the book documentation itself. However, currently this wouldn't be possible because we're piggy-backing off of the jupyter.org account, and this account points to the GitHub-pages nameservers.

We won't be able to change that (unless Jupyter itself moves to netlify), however we could host the documentation at our own URL (I conveniently grabbed jupyterbook.org) if we'd like.

What do folks think about this? I don't think it's such a big deal to change the URL (we'd just need to add a redirect for jupyter.org/jupyter-book). However, is it a good idea in the first place?

Most helpful comment

I've got the netlify version hosting working now!

https://jupyterbook.org

If we decide that we want to do this, we should make sure the old docs redirect before making a full switch.

All 5 comments

The main benefit, in my mind, would be if it makes deployment easier. I quite like the Netlify github bots, but you've already spent quite a bit of time getting the CircleCI integration off the ground, so I'm not sure if it's a huge gain at the moment. That being said, if we add more features that github doesn't handle well -- or if we move from Jekyll to another static site generator like Hugo -- the impact would be much more significant !

The other possibility is that the move would just be useful from an ideological standpoint, in that we're diversifying our dependencies (i.e., not totally tied to GitHub). No strong feelings on that one, personally.

A few pros that come to my mind:

  • Tests would be less complicated, we'd be using CircleCI just to run tests and not to demo the book itself. (I have absolutely no problem deleting all the stuff I put together to build and demo the book with CircleCI haha...though maybe we'd want to keep some of it around just to make sure it still works)
  • Having an independent URL would give us a bit more flexibility if we wanted to do more stuff (e.g. have sub-domains or a more "meta" page that's different from the book documentation).
  • I am always +1 on diversifying our build/ci/cd dependencies
  • Maybe jupyterbook.org would be easier to remember and feel more like its own project? I'm not sure on that one...curious what folks think about it.

I've got the netlify version hosting working now!

https://jupyterbook.org

If we decide that we want to do this, we should make sure the old docs redirect before making a full switch.

It looks like you have a redirect on this now ?! Should we close this issue ? :smile:

yes! thanks for checking

Was this page helpful?
0 / 5 - 0 ratings