start of user tooling post #3
Conversation
|
I've reworked the text a bit so we only mention the command once, which will lower the future burden to maintain it up to date. I'm also going to leave a couple of comments for consideration. |
| ## Assumptions | ||
|
|
||
| 1. You have admin rights over your machine | ||
| 2. You are running either Windows 10 Pro, macOS, or Linux |
There was a problem hiding this comment.
Should we give an option for those who don't meet these requirements? Arguably, that'll be quite a few of our readers.
| [Install Docker Desktop for Windows](https://docs.docker.com/v17.09/engine/installation/) | ||
|
|
||
| ### macOS | ||
| [Get started with Docker Desktop for Max](https://docs.docker.com/docker-for-mac/) |
| git clone git@github.com:gdsbook/book.git | ||
| ``` | ||
|
|
||
| This will create a directory named `gdsbook` under the current working directory. |
There was a problem hiding this comment.
The directory would be called book, right?
|
|
||
| ## Acquire book source materials | ||
|
|
||
| In order to work with the book locally, you need to acquire the source files. There are two ways to do so. . If you are familiar with [git](https://github.com/) you can clone the repository with: |
There was a problem hiding this comment.
It might be worth mentioning the container includes an installation of git, so we might want to first show how to launch the container, and then how to clone the repo from the container?
|
|
||
| If you do not want to use git, you can download the source files in a zip archive by selecting <https://github.com/gdsbook/book/archive/master.zip>. | ||
|
|
||
| Once downloaded, extract the files and rename the resulting directory. On Linux or macOS you would do: |
There was a problem hiding this comment.
I'd also mention you can do it manually without the command line, this will scare some people...
| [Jupyter](https://jupyter.org/) session from the same terminal used above, as follows: | ||
|
|
||
| ``` | ||
| > docker run --rm -ti -p 8888:8888 -v ${PWD}:/home/jovyan/work gdsbook |
There was a problem hiding this comment.
Replace gdsbook for gdsbook/stack
| > docker run --rm -ti -p 8888:8888 -v ${PWD}:/home/jovyan/work gdsbook | ||
| ``` | ||
|
|
||
| This will start a Python session, please do not quite the window until you are done using Python! |
There was a problem hiding this comment.
We need to add line to point the browser to localhost:8888
|
More for discussion but, given how I'm structuring Chapter 1, I wonder whether the basics that are currently covered could be moved to the final subsection ( |
|
I think that's a great idea! From the perspective of someone interested in how we're doing what we're doing, I think the blogpost makes sense. We wouldn't want to replicate too much of the content in the book, and instead link to it if we can. |
This is on hold until we resolve the container bug.
Once that issue is resolved, we can add to this post: