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

User Guide: remove docker-compose reference #317

Open
Tracked by #337
bertsky opened this issue Jul 13, 2022 · 3 comments
Open
Tracked by #337

User Guide: remove docker-compose reference #317

bertsky opened this issue Jul 13, 2022 · 3 comments
Assignees

Comments

@bertsky
Copy link
Collaborator

bertsky commented Jul 13, 2022

I see no point in linking to the installation instructions for docker-compose at this point. It is highly technical and we don't even use docker-compose (yet).

Also, the whole section Setup docker really belongs to the Setup Guide. (Yes, there should be a back-reference to the setup guide, but the gist of the information should be there, not here.)

@bertsky
Copy link
Collaborator Author

bertsky commented Mar 8, 2023

ping @lena-hinrichsen

@lena-hinrichsen
Copy link
Member

Also, the whole section Setup docker really belongs to the Setup Guide. (Yes, there should be a back-reference to the setup guide, but the gist of the information should be there, not here.)

Question about this: The step

# Start docker daemon at startup
sudo systemctl enable docker
# Add user to group 'docker'
sudo usermod -aG docker $USER

only has to be done once (after the setup with Docker), am I correct? That's why it should be in the Setup Guide so it's redundant in the User Guide?

And:
Would you recommend to run docker images as a test once after installation or every time after starting the OS/shell/whatever?

@bertsky
Copy link
Collaborator Author

bertsky commented Apr 8, 2023

Question about this: The step [...] only has to be done once (after the setup with Docker), am I correct?

Yes, only once – sometimes it even comes with the system package for Docker as a post-install step.

That's why it should be in the Setup Guide so it's redundant in the User Guide?

Yes. However, it does make sense to discern the two scenarios Docker vs native – they do have diverging prerequisites. For Docker, it's simply following the Docker part of the Setup Guide and perhaps logging into the Docker container, for native, it's activating your (install-time) venv in the current shell.

And: Would you recommend to run docker images as a test once after installation or every time after starting the OS/shell/whatever?

No – keep it simple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants