Skip to content

Commit 440d865

Browse files
committed
documentation text updates
1 parent 2618405 commit 440d865

4 files changed

Lines changed: 42 additions & 47 deletions

File tree

.github/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="/.github/home-page-images/laradock-logo.jpg?raw=true" alt="Laradock Logo"/>
33
</p>
44

5-
<p align="center">A Docker PHP development environment that facilitates running PHP Apps on Docker</p>
5+
<p align="center">PHP development environment that runs on Docker</p>
66

77
<p align="center">
88
<a href="https://travis-ci.org/laradock/laradock"><img src="https://travis-ci.org/laradock/laradock.svg?branch=master" alt="Build status"></a>
@@ -13,7 +13,7 @@
1313
<a href="http://laradock.io/contributing"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="contributions welcome"></a>
1414
</p>
1515

16-
<h4 align="center" style="color:#7d58c2">Use Docker First And Learn About It Later</h4>
16+
<h4 align="center" style="color:#7d58c2">Use Docker First - Then Learn About It Later</h4>
1717

1818
<p align="center">
1919
<a href="http://zalt.me"><img src="http://forthebadge.com/images/badges/built-by-developers.svg" alt="forthebadge" width="240" ></a>
@@ -44,9 +44,9 @@ For basic sponsorships go to [Open Collective](https://opencollective.com/larado
4444

4545
*Your logo will show up on the [github repository](https://github.com/laradock/laradock/) index page and the [documentation](http://laradock.io/) main page, with a link to your website.*
4646

47-
## Contributors
47+
## People
4848

49-
#### Core contributors:
49+
#### Maintainers:
5050
- [Mahmoud Zalt](https://github.com/Mahmoudz) @mahmoudz | [Twitter](https://twitter.com/Mahmoud_Zalt) | [Site](http://zalt.me)
5151
- [Bo-Yi Wu](https://github.com/appleboy) @appleboy | [Twitter](https://twitter.com/appleboy)
5252
- [Philippe Trépanier](https://github.com/philtrep) @philtrep
@@ -59,9 +59,9 @@ For basic sponsorships go to [Open Collective](https://opencollective.com/larado
5959
- [Milan Urukalo](https://github.com/urukalo) @urukalo
6060
- [Vince Chu](https://github.com/vwchu) @vwchu
6161
- [Huadong Zuo](https://github.com/zuohuadong) @zuohuadong
62-
- Join us, by submitting 20 useful PR's.
62+
- Join us.
6363

64-
#### Awesome contributors:
64+
#### Awesome Contributors:
6565

6666
<a href="https://github.com/laradock/laradock/graphs/contributors"><img src="https://opencollective.com/laradock/contributors.svg?width=890" /></a>
6767

DOCUMENTATION/content/documentation/index.md

Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,24 @@ e) set it to `true`
297297

298298
For information on how to configure xDebug with your IDE and work it out, check this [Repository](https://github.com/LarryEitel/laravel-laradock-phpstorm) or follow up on the next section if you use linux and PhpStorm.
299299

300+
301+
302+
<br>
303+
<a name="Control-xDebug"></a>
304+
## Start/Stop xDebug:
305+
306+
By installing xDebug, you are enabling it to run on startup by default.
307+
308+
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):
309+
310+
- Stop xDebug from running by default: `.php-fpm/xdebug stop`.
311+
- Start xDebug by default: `.php-fpm/xdebug start`.
312+
- See the status: `.php-fpm/xdebug status`.
313+
314+
Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebug` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions.
315+
316+
317+
300318
<br>
301319
<a name="Install-phpdbg"></a>
302320
## Install phpdbg
@@ -321,22 +339,6 @@ PHP_FPM_INSTALL_PHPDBG=true
321339

322340

323341

324-
<br>
325-
<a name="Control-xDebug"></a>
326-
## Start/Stop xDebug:
327-
328-
By installing xDebug, you are enabling it to run on startup by default.
329-
330-
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):
331-
332-
- Stop xDebug from running by default: `.php-fpm/xdebug stop`.
333-
- Start xDebug by default: `.php-fpm/xdebug start`.
334-
- See the status: `.php-fpm/xdebug status`.
335-
336-
Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebug` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions.
337-
338-
339-
340342

341343
<br>
342344
<a name="Install-ionCube-Loader"></a>
@@ -1566,22 +1568,6 @@ Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker
15661568

15671569

15681570

1569-
<br>
1570-
<a name="MySQL-access-from-host"></a>
1571-
## MySQL access from host
1572-
1573-
You can forward the MySQL/MariaDB port to your host by making sure these lines are added to the `mysql` or `mariadb` section of the `docker-compose.yml` or in your [environment specific Compose](https://docs.docker.com/compose/extends/) file.
1574-
1575-
```
1576-
ports:
1577-
- "3306:3306"
1578-
```
1579-
1580-
1581-
1582-
1583-
1584-
15851571
<br>
15861572
<a name="MySQL-root-access"></a>
15871573
## MySQL root access
@@ -1682,7 +1668,7 @@ Enabling Global Composer Install during the build for the container allows you t
16821668

16831669
<br>
16841670
<a name="Magento-2-authentication-credentials"></a>
1685-
## Magento 2 authentication credential (composer install)
1671+
## Add authentication credential for Magento 2
16861672

16871673
1 - Open the `.env` file
16881674

DOCUMENTATION/content/getting-started/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Note: If you are not using Git yet for your project, you can use `git clone` ins
4141
*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)*
4242

4343

44-
Your folder structure should look like this:
44+
2 - Make sure your folder structure should look like this:
4545

4646
```
4747
+ project-a
@@ -52,7 +52,7 @@ Your folder structure should look like this:
5252

5353
*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).*
5454

55-
> **Now jump to the [Usage](#Usage) section.**
55+
3 - Go to the [Usage](#Usage) section.
5656

5757
<a name="A2"></a>
5858
### A.2) Don't have a PHP project yet:
@@ -86,7 +86,7 @@ APP_CODE_PATH_HOST=../project-z/
8686

8787
Make sure to replace `project-z` with your project folder name.
8888

89-
> **Now jump to the [Usage](#Usage) section.**
89+
3 - Go to the [Usage](#Usage) section.
9090

9191

9292
<a name="B"></a>
@@ -127,7 +127,7 @@ You can rename the config files, project folders and domains as you like, just m
127127

128128
If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https://laravel-news.com/chrome-63-now-forces-dev-domains-https). Instead use `.localhost`, `.invalid`, `.test`, or `.example`.
129129

130-
> **Now jump to the [Usage](#Usage) section.**
130+
4 - Go to the [Usage](#Usage) section.
131131

132132

133133

@@ -213,7 +213,16 @@ Open your PHP project's `.env` file or whichever configuration file you are read
213213
DB_HOST=mysql
214214
```
215215

216+
You need to use the Laradock's default DB credentials which can be found in the `.env` file (ex: `MYSQL_USER=`).
217+
Or you can change them and rebuild the container.
218+
216219
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
217220

218221
<br>
219-
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.test/` and `http://project-2.test/`.
222+
5 - Open your browser and visit your localhost address.
223+
224+
If you followed the multiple projects setup, you can visit `http://project-1.test/` and `http://project-2.test/`.
225+
226+
[http://localhost:8080](http://localhost:8080)
227+
228+
Make sure you add use the right port number as provided by your running server. Ex: NGINX uses port 8080 by default while Apache2 uses 80.

DOCUMENTATION/content/introduction/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ weight: 1
55
---
66

77

8+
## Use Docker First - Then Learn About It Later
89

9-
10-
A full PHP development environment for Docker.
10+
Laradock is a PHP development environment that runs on Docker.
1111

1212
Supports a variety of useful Docker Images, pre-configured to provide a wonderful PHP development environment.
1313

@@ -175,7 +175,7 @@ That's it! enjoy :)
175175
- Web IDE
176176
177177
- **Miscellaneous:**
178-
- Workspace: *(Laradock container that includes a rich set of pre-configured useful tools)*
178+
- Workspace *(Laradock container that includes a rich set of pre-configured useful tools)*
179179
- `PHP CLI`
180180
- `Composer`
181181
- `Git`

0 commit comments

Comments
 (0)