Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker instructions for developers in the docs #837

Open
RemDelaporteMathurin opened this issue May 10, 2021 · 1 comment
Open

Add docker instructions for developers in the docs #837

RemDelaporteMathurin opened this issue May 10, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@RemDelaporteMathurin
Copy link

Detailed instructions for contributors using Docker could be beneficial (which dependencies image should we use, which Docker command, etc...)

Maybe I'm just being lazy (or have a really bad memory) but I keep forgetting the syntax for running a container with shared volumes.

Plus, the ukaea/paramak:dependencies doesn't seem to be specified anywhere in the installation section.

Just adding the following command would save a lot of time (in my opinion):

docker run -it -v $(pwd):/home/shared ukaea/paramak:dependencies

For windows:
docker run -it -v ${PWD}:/home/shared ukaea/paramak:dependencies

@shimwell
Copy link
Collaborator

yep nice suggestion. I can take a look at the docs for the install and perhaps move the install into a few separate sections

Everything is on the index page at the moment but that is a bit crowded

@RemDelaporteMathurin RemDelaporteMathurin added the documentation Improvements or additions to documentation label May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants