Skip to content

Commit cc92ad1

Browse files
committed
chore: updates docker_readme
1 parent 23936ea commit cc92ad1

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

DOCKER_README.MD

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
This guide shows our recommended recommended way of installing Docker on your OS X machine.
1+
In this page you will find our recommended way of installing Docker on your machine.
2+
This guide is made for OSX users.
23

34
## Install docker
45

@@ -7,23 +8,23 @@ First install Docker using [Homebrew](https://brew.sh/)
78
$ brew install docker
89
```
910

10-
You can install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use the `docker-machine` command to work with your Docker containers. This guide assumes you use the `docker-machine` command.
11+
You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
1112

12-
## Setup your Docker
13+
## Setup your docker
1314

1415
Install `docker-machine`
1516
```
1617
$ brew install docker-machine
1718
```
1819

19-
Then install [VirtualBox](https://www.virtualbox.org/) using [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
20+
Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
2021
```
2122
$ brew cask install virtualbox
2223
```
2324

24-
You may need to enter your password and authorize the application through `System Settings` > `Security & Privacy`.
25+
You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
2526

26-
Create a new machine, and set it up as default, and connect your shell to the machine with the following commands:
27+
Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
2728

2829
```
2930
$ docker-machine create --driver virtualbox default
@@ -42,13 +43,13 @@ docker build -t algolia-ruby .
4243
## Run the image
4344

4445
You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite).
45-
You can set them up directly in the command
46+
You can set them up directly in the command:
4647

4748
```bash
48-
docker run -it --rm --env ALGOLIA_APPLICATION_ID_1=XXXXXX [...] -v $PWD:/app -w /app algolia-ruby bash
49+
docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-ruby bash
4950
```
5051

51-
But we advise you export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to retrieve your variables.
52+
However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
5253

5354
```bash
5455
### For external contributors, only the following env variables should be enough
@@ -68,9 +69,9 @@ docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
6869
-v $PWD:/app -w /app algolia-ruby bash
6970
```
7071

71-
Once the container is up, you can edit files directly in your IDE: changes will be mirrored in the image.
72+
Once your container is running, any changes you make in your IDE are directly reflected in the container.
7273

73-
Lastly to launch the tests, you can use one of the following commands
74+
To launch the tests, you can use one of the following commands
7475
```shell script
7576
# run only the unit tests
7677
bundle exec rake test:unit

0 commit comments

Comments
 (0)