Skip to content

Commit 5da5d5e

Browse files
authored
Merge pull request laradock#476 from jbaron-mx/master
Fix typos and missing commas in docs
2 parents 4f819c2 + 19a2110 commit 5da5d5e

2 files changed

Lines changed: 33 additions & 33 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Your contribution is more than welcome. Let's keep LaraDock amazing.
55

66
### Got a Question or Problem?
77

8-
If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you beleave your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
8+
If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
99

1010
### Found an Issue?
1111
If you find a bug in the source code or a mistake in the documentation, you can help us by

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Laradock is a Docker PHP development environment. It facilitate running **PHP** Apps on **Docker**.
88

9-
Laradock is configured to run Laravel Apps by default, and it can be modifyed to run all kinds of PHP Apps (Symfony, Codeigniter, Wordpress, Drupal...).
9+
Laradock is configured to run Laravel Apps by default, and it can be modified to run all kinds of PHP Apps (Symfony, CodeIgniter, Wordpress, Drupal...).
1010

1111
>Use Docker first and learn about it later.
1212
@@ -41,7 +41,7 @@ Laradock is configured to run Laravel Apps by default, and it can be modifyed to
4141
- [Change the PHP-FPM Version](#Change-the-PHP-FPM-Version)
4242
- [Change the PHP-CLI Version](#Change-the-PHP-CLI-Version)
4343
- [Install xDebug](#Install-xDebug)
44-
- [Start/Stop xDebug](#Controll-xDebug)
44+
- [Start/Stop xDebug](#Control-xDebug)
4545
- [Production](#Production)
4646
- [Prepare LaraDock for Production](#LaraDock-for-Production)
4747
- [Setup Laravel and Docker on Digital Ocean](#Digital-Ocean)
@@ -53,8 +53,8 @@ Laradock is configured to run Laravel Apps by default, and it can be modifyed to
5353
- [Use phpMyAdmin](#Use-phpMyAdmin)
5454
- [Use pgAdmin](#Use-pgAdmin)
5555
- [Use ElasticSearch](#Use-ElasticSearch)
56-
- [Codeigniter](#Codeigniter):
57-
- [Install Codeigniter](#Install-Codeigniter)
56+
- [CodeIgniter](#CodeIgniter):
57+
- [Install CodeIgniter](#Install-CodeIgniter)
5858
- [Misc](#Misc)
5959
- [Change the timezone](#Change-the-timezone)
6060
- [Cron jobs](#CronJobs)
@@ -393,7 +393,7 @@ If you need a special support. Contact me, more details in the [Help & Questions
393393
```bash
394394
docker ps
395395
```
396-
You can also use the this command if you want to see only this project containers:
396+
You can also use the following command if you want to see only this project containers:
397397

398398
```bash
399399
docker-compose ps
@@ -438,9 +438,9 @@ docker-compose down
438438
<a name="Enter-Container"></a>
439439
### Enter a Container (run commands in a running Container)
440440

441-
1 - first list the current running containers with `docker ps`
441+
1 - First list the current running containers with `docker ps`
442442

443-
2 - enter any container using:
443+
2 - Enter any container using:
444444

445445
```bash
446446
docker-compose exec {container-name} bash
@@ -452,7 +452,7 @@ docker-compose exec {container-name} bash
452452
docker-compose exec mysql bash
453453
```
454454

455-
3 - to exit a container, type `exit`.
455+
3 - To exit a container, type `exit`.
456456

457457

458458

@@ -597,7 +597,7 @@ The PHP-CLI extensions should be installed in `workspace/Dockerfile`.
597597
### Change the (PHP-FPM) Version
598598
By default **PHP-FPM 7.0** is running.
599599

600-
>The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planing to run your application on different PHP-FPM version.
600+
>The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planning to run your application on different PHP-FPM version.
601601
602602
#### A) Switch from PHP `7.0` to PHP `5.6`
603603

@@ -656,7 +656,7 @@ We do not natively support PHP 5.5 anymore, but you can get it in few steps:
656656
### Change the PHP-CLI Version
657657
By default **PHP-CLI 7.0** is running.
658658

659-
>Note: it's not very essential to edit the PHP-CLI verion. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.
659+
>Note: it's not very essential to edit the PHP-CLI version. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.
660660
661661
The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to edit the `workspace/Dockerfile`.
662662

@@ -712,12 +712,12 @@ For information on how to configure xDebug with your IDE and work it out, check
712712

713713

714714
<br>
715-
<a name="Controll-xDebug"></a>
715+
<a name="Control-xDebug"></a>
716716
### Start/Stop xDebug:
717717

718718
By installing xDebug, you are enabling it to run on startup by default.
719719

720-
To controll the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):
720+
To control the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):
721721

722722
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
723723
- Start xDebug by default: `./xdebugPhpFpm start`.
@@ -737,7 +737,7 @@ To controll the behavior of xDebug (in the `php-fpm` Container), you can run the
737737
<a name="LaraDock-for-Production"></a>
738738
### Prepare LaraDock for Production
739739

740-
It's recommended for production to create a custom `docker-compose.yml` file. For that reason LaraDock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage exampe: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
740+
It's recommended for production to create a custom `docker-compose.yml` file. For that reason, LaraDock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage exampe: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
741741

742742
Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:
743743

@@ -797,7 +797,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
797797

798798
3 - Edit `docker-compose.yml` to Map the new application path:
799799

800-
By default LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
800+
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
801801

802802
Since the new Laravel application is in the `my-cool-app` folder, we need to replace `../:/var/www` with `../my-cool-app/:/var/www`, as follow:
803803

@@ -814,7 +814,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
814814
cd my-cool-app
815815
```
816816

817-
5 - Go back to the laraDock installation steps to see how to edit the `.env` file.
817+
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file.
818818

819819

820820

@@ -873,7 +873,7 @@ docker-compose up -d redis
873873
REDIS_HOST=redis
874874
```
875875

876-
If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database config file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
876+
If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database configuration file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
877877

878878
```php
879879
'redis' => [
@@ -953,7 +953,7 @@ docker-compose up -d mongo
953953
```
954954

955955

956-
4 - Add the MongoDB configurations to the `config/database.php` config file:
956+
4 - Add the MongoDB configurations to the `config/database.php` configuration file:
957957

958958
```php
959959
'connections' => [
@@ -1065,15 +1065,15 @@ docker restart {container-name}
10651065

10661066

10671067
<br>
1068-
<a name="Codeigniter"></a>
1068+
<a name="CodeIgniter"></a>
10691069
<br>
10701070

10711071

10721072

1073-
<a name="Install-Codeigniter"></a>
1074-
### Install Codeigniter
1073+
<a name="Install-CodeIgniter"></a>
1074+
### Install CodeIgniter
10751075

1076-
To install Codeigniter 3 on Laradock all you have to do is the following simple steps:
1076+
To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
10771077

10781078
1 - Open the `docker-compose.yml` file.
10791079

@@ -1175,7 +1175,7 @@ Modify the `mysql/my.cnf` file to set your port number, `1234` is used as an exa
11751175
port=1234
11761176
```
11771177

1178-
If you need <a href="#MySQL-access-from-host">MySQL access from your host</a>, do not forget to change the internal port number (`"3306:3306"` -> `"3306:1234"`) in the docker-compose config file.
1178+
If you need <a href="#MySQL-access-from-host">MySQL access from your host</a>, do not forget to change the internal port number (`"3306:3306"` -> `"3306:1234"`) in the docker-compose configuration file.
11791179

11801180
<a name="Use-custom-Domain"></a>
11811181
### Use custom Domain (instead of the Docker IP)
@@ -1191,7 +1191,7 @@ Assuming your custom domain is `laravel.dev`
11911191
2 - Open your browser and visit `{http://laravel.dev}`
11921192

11931193

1194-
Optionally you can define the server name in the nginx config file, like this:
1194+
Optionally you can define the server name in the nginx configuration file, like this:
11951195

11961196
```conf
11971197
server_name laravel.dev;
@@ -1205,9 +1205,9 @@ server_name laravel.dev;
12051205

12061206
Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.
12071207

1208-
1 - open the `docker-compose.yml` file
1208+
1 - Open the `docker-compose.yml` file
12091209

1210-
2 - search for the `COMPOSER_GLOBAL_INSTALL` argument under the Workspace Container and set it to `true`
1210+
2 - Search for the `COMPOSER_GLOBAL_INSTALL` argument under the Workspace Container and set it to `true`
12111211

12121212
It should be like this:
12131213

@@ -1219,9 +1219,9 @@ It should be like this:
12191219
- COMPOSER_GLOBAL_INSTALL=true
12201220
...
12211221
```
1222-
3 - now add your dependencies to `workspace/composer.json`
1222+
3 - Now add your dependencies to `workspace/composer.json`
12231223

1224-
4 - rebuild the Workspace Container `docker-compose build workspace`
1224+
4 - Re-build the Workspace Container `docker-compose build workspace`
12251225

12261226

12271227

@@ -1238,11 +1238,11 @@ Click on this [Enable Global Composer Build Install](#Enable-Global-Composer-Bui
12381238

12391239
2 - Add prestissimo as requirement in Composer:
12401240

1241-
a - now open the `workspace/composer.json` file
1241+
a - Now open the `workspace/composer.json` file
12421242

1243-
b - add `"hirak/prestissimo": "^0.3"` as requirement
1243+
b - Add `"hirak/prestissimo": "^0.3"` as requirement
12441244

1245-
c - rebuild the Workspace Container `docker-compose build workspace`
1245+
c - Re-build the Workspace Container `docker-compose build workspace`
12461246

12471247

12481248

@@ -1378,7 +1378,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
13781378

13791379
#### I get Mysql connection refused
13801380

1381-
This error is sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
1381+
This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
13821382

13831383
* Option A
13841384
1. Check your running Laravel application IP by dumping `Request::ip()` variable using `dd(Request::ip())` anywhere on your application. The result is the IP of your Laravel container.
@@ -1414,7 +1414,7 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ
14141414
<br>
14151415
## Contributing
14161416

1417-
This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else.. Do not hesitate to contribute, you are more than welcome :)
1417+
This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else, do not hesitate to contribute, you are more than welcome :)
14181418

14191419
#### Read the [Contribution Guidelines](https://github.com/LaraDock/laradock/blob/master/CONTRIBUTING.md).
14201420

0 commit comments

Comments
 (0)