[ENH] Initial commit of dockerfile, updated docs

[emdupre]

References #125

Creating a dockerfile to serve jupyter-books, updating documentation to reference include the correct docker commands.

[jasmainak]

I've been using this for the last few days (thanks @emdupre !). It works nicely on my laptop. However, I discovered one other limitation of this approach that one needs to be aware of. If you don't have sudo (e.g., on work computers), you can't install docker (and it's likely very difficult to convince some IT departments :). Conda on the other hand works also without root access.

[emdupre]

In that case you'd build a Singularity container :) From dockerhub (if we host it there) or by building a Singularity file directly from the Dockerfile.

I'll go ahead and add docs for doing either, but not sure if we should bet on this horse or on #83 (comment) !

[jasmainak]

okay I will experiment with Singularity. But I don't want to hold up this PR because of that. Feel free to move on once the Dockerfile issue is solved !

[choldgraf]

@emdupre is this one ready to go?

[mathieuboudreau]

Any advice for how to integrate this into a project that depends on another Dockerfile for the Jupyter Notebooks running on MyBinder? And if so would it be worth documenting here?

e.g. Since in my project, https://github.com/qMRLab/t1_book, I already have a Dockerfile in the root of the repo to build the Jupyter environment, and I think MyBinder only looks for dockerfiles at this repo level, what's the best strategy to manage both of these for a live site on github? Would it be to make my old site in a new directory (somewhat like what's done currently in this repo here), keep my Jupyter-Dockerfile in root and add your Ruby-Dockerfile in the new directory? Or make the live site from a gh-pages branch with the Ruby-Dockerfile there, and keep my Jupyter-Dockerfile in master or another branch? Sorry if this is confusing; it's the first time I have a repo needing two Dockerfiles, and the location you placed yours (the demo book) is where my old dockerfile lived.

[emdupre]

Not yet, but I can finish it tonight -- for now I can host the image on my personal dockerhub account ?

…

On Thu., Mar. 14, 2019, 17:25 Chris Holdgraf, ***@***.***> wrote: @emdupre <https://github.com/emdupre> is this one ready to go? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#127 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOUk5-zNoLM4zSW0bISrsjweM0loExxlks5vWr5JgaJpZM4bmdCe> .

[emdupre]

@mathieuboudreau, I've just updated this PR and pointed to my DockerHub image -- can you try that by chance ? I've also moved the Dockerfile up one directory so it shouldn't conflict with project specific Dockerfiles !

PS @jasmainak: If you're still interested in using Singularity I updated the build instructions to explain how to do it !

[mathieuboudreau]

@emdupre pulling from Dockerhub works great - thanks a lot! 💯

[emdupre]

OK, I think it's ready now @choldgraf if you want to do a final review ! 😸

[choldgraf]

this all looks great to me, and given that a few folks have already said this works for them, I think we should merge! 🎉 thanks @emdupre :-)

[choldgraf]

@emdupre two quick things:

1. I don't see this documentation reflected in the jupyter book online docs...I wonder if we've got an error in the circle build somewhere?

2. I tried running this on a windows machine and got this error:

Configuration file: none
            Source: /srv/jekyll
       Destination: /srv/jekyll/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
       Jekyll Feed: Generating feed for posts
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
   GitHub Metadata: Error processing value 'title':
  Liquid Exception: No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository. in feed.xml
             ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository.

is that something you've run into before?

[emdupre]

I've never seen that 🤔 -- but could you try this ? github/pages-gem#399 (comment)

🤞 🤞 it works !!