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.

Sign up for GitHub

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

docs: Update quickstart.md to use Docker daemon #5576

Merged
merged 3 commits into from
Apr 9, 2024
Merged

docs: Update quickstart.md to use Docker daemon #5576

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78b62b3
Docs: Update quickstart.md to use Docker daemon
jzaki Apr 4, 2024
b7bb0ec
Merge branch 'master' into jz/docs-docker-daemon
jzaki Apr 8, 2024
351a63a
Precise Docker/daemon in quickstart.md instructions
jzaki Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/docs/developers/getting_started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ In this guide, you will

- Node.js >= v18 (recommend installing with [nvm](https://github.com/nvm-sh/nvm))

## Install Docker
## Install Docker daemon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you're still installing docker, why include the word daemon?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See docker instructions. Docker funnels people to think Docker = Docker Desktop. We explicitly want the daemon.
If they have speed issues running aztec/noir commands, we specifically wan't devs to close Docker desktop, but have the daemon running.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but 'docker daemon' isn't something you install, you install docker and it starts a daemon. devs can install docker however they want, I think we should just have a note that says "if docker desktop runs slowly for you, consider starting the daemon manually" and give instructions. docker desktop is only slow on a very small minority of machines

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated - removed "daemon" from title, and explained more of what is needed.

Wanted to keep it to the point since it's before they even start using Aztec, but if Docker is open on the desktop, Aztec's dev exp will be unnecessarily slow.
For how Docker refers to Docker Daemon, see here.


See [this page of the Docker docs](https://docs.docker.com/get-docker/) for instructions on how to install Docker Desktop for your operating system.
Docker daemon is easily installed via Docker Desktop. See [this page of the Docker docs](https://docs.docker.com/get-docker/) for instructions on how to install Docker Desktop for your operating system.
Note: if installing via Docker Desktop, you do NOT need to keep the application open at all times (just the daemon).

Once you have Docker installed, make sure it is running by opening the Docker Desktop application.
Docker daemon can also be installed via Docker Engine, see [these instructions](https://docs.docker.com/engine/install/).

After Docker daemon is installed, ensure you have it running. See [start Docker daemon](https://docs.docker.com/config/daemon/start/).

### Note on Linux

Expand Down
Loading