Skip to content

Commit 599c876

Browse files
committed
address @effigies review comments
1 parent e66cefd commit 599c876

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/contributors.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ update an existing environment, as necessary.
1010
Development in Docker is encouraged, for the sake of consistency and
1111
portability.
1212
By default, work should be built off of `poldracklab/fmriprep:unstable
13-
<https://hub.docker.com/r/poldracklab/fmriprep/>`_ (see the
13+
<https://hub.docker.com/r/poldracklab/fmriprep/>`_, which tracks the ``master`` branch,
14+
or ``poldracklab/fmriprep:latest``, which tracks the latest release version (see the
1415
installation_ guide for the basic procedure for running).
1516

1617
It will be assumed the developer has a working repository in
@@ -140,15 +141,15 @@ development environment, we have an experimental setup with `code-server
140141
We have `a video walking through the process
141142
<https://youtu.be/bkZ-NyUaTvg>`_ if you want a visual guide.
142143

143-
1. build the docker image
144+
1. Build the Docker image
144145
~~~~~~~~~~~~~~~~~~~~~~~~~
145146
We will use the ``Dockerfile_devel`` file to build
146147
our development docker image::
147148

148149
$ cd $HOME/projects/fmriprep
149150
$ docker build -t fmriprep_devel -f Dockerfile_devel .
150151

151-
2. run the docker image
152+
2. Run the Docker image
152153
~~~~~~~~~~~~~~~~~~~~~~~
153154
We can start a docker container using the image we built (``fmriprep_devel``)::
154155

@@ -162,8 +163,8 @@ We can start a docker container using the image we built (``fmriprep_devel``)::
162163
If you are using Docker-Toolbox, you will need to change your virtualbox settings
163164
using `these steps as a guide
164165
<https://github.com/jdkent/tutDockerRstudio#additional-setup-for-docker-toolbox>`_.
165-
For step ``6``, instead of ``Name = rstudio; Host Port = 8787; Guest Port = 8787``,
166-
have ``Name = code-server; Host Port = 8443; Guest Port = 8080``.
166+
(For step ``6``, instead of ``Name = rstudio; Host Port = 8787; Guest Port = 8787``,
167+
have ``Name = code-server; Host Port = 8443; Guest Port = 8080``.)
167168
Then in the docker command above, change ``127.0.0.1:8445:8080``
168169
to ``192.168.99.100:8445:8080``.
169170

@@ -176,10 +177,10 @@ If the container started correctly, you should see the following on your console
176177
Now you can switch to your favorite browser and go to: ``127.0.0.1:8445``
177178
(or ``192.168.99.100:8445`` for Docker Toolbox).
178179

179-
3. copy fmriprep.egg-info into your fmriprep directory
180+
3. Copy fmriprep.egg-info into your fmriprep directory
180181
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181-
``fmriprep.egg-info`` contains the necessary information for the fmriprep package for it
182-
to be run inside the docker container. Open a terminal in vscode and type the following::
182+
``fmriprep.egg-info`` makes the fmriprep package exacutable inside the docker container.
183+
Open a terminal in vscode and type the following::
183184

184185
$ cp -R /src/fmriprep.egg-info /src/fmriprep/
185186

0 commit comments

Comments
 (0)