From 440d865fc4579657f57eba24035674295cb4fdc5 Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Tue, 23 Jul 2019 22:45:05 +0200 Subject: [PATCH] documentation text updates --- .github/README.md | 12 ++--- DOCUMENTATION/content/documentation/index.md | 52 +++++++------------ .../content/getting-started/index.md | 19 +++++-- DOCUMENTATION/content/introduction/index.md | 6 +-- 4 files changed, 42 insertions(+), 47 deletions(-) diff --git a/.github/README.md b/.github/README.md index 29b2cca8..529d8322 100644 --- a/.github/README.md +++ b/.github/README.md @@ -2,7 +2,7 @@ Laradock Logo

-

A Docker PHP development environment that facilitates running PHP Apps on Docker

+

PHP development environment that runs on Docker

Build status @@ -13,7 +13,7 @@ contributions welcome

-

Use Docker First And Learn About It Later

+

Use Docker First - Then Learn About It Later

forthebadge @@ -44,9 +44,9 @@ For basic sponsorships go to [Open Collective](https://opencollective.com/larado *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.* -## Contributors +## People -#### Core contributors: +#### Maintainers: - [Mahmoud Zalt](https://github.com/Mahmoudz) @mahmoudz | [Twitter](https://twitter.com/Mahmoud_Zalt) | [Site](http://zalt.me) - [Bo-Yi Wu](https://github.com/appleboy) @appleboy | [Twitter](https://twitter.com/appleboy) - [Philippe Trépanier](https://github.com/philtrep) @philtrep @@ -59,9 +59,9 @@ For basic sponsorships go to [Open Collective](https://opencollective.com/larado - [Milan Urukalo](https://github.com/urukalo) @urukalo - [Vince Chu](https://github.com/vwchu) @vwchu - [Huadong Zuo](https://github.com/zuohuadong) @zuohuadong -- Join us, by submitting 20 useful PR's. +- Join us. -#### Awesome contributors: +#### Awesome Contributors: diff --git a/DOCUMENTATION/content/documentation/index.md b/DOCUMENTATION/content/documentation/index.md index 2560a8e5..a9aeb8a1 100644 --- a/DOCUMENTATION/content/documentation/index.md +++ b/DOCUMENTATION/content/documentation/index.md @@ -297,6 +297,24 @@ e) set it to `true` 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. + + +
+ +## Start/Stop xDebug: + +By installing xDebug, you are enabling it to run on startup by default. + +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): + +- Stop xDebug from running by default: `.php-fpm/xdebug stop`. +- Start xDebug by default: `.php-fpm/xdebug start`. +- See the status: `.php-fpm/xdebug status`. + +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. + + +
## Install phpdbg @@ -321,22 +339,6 @@ PHP_FPM_INSTALL_PHPDBG=true -
- -## Start/Stop xDebug: - -By installing xDebug, you are enabling it to run on startup by default. - -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): - -- Stop xDebug from running by default: `.php-fpm/xdebug stop`. -- Start xDebug by default: `.php-fpm/xdebug start`. -- See the status: `.php-fpm/xdebug status`. - -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. - - -
@@ -1566,22 +1568,6 @@ Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker -
- -## MySQL access from host - -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. - -``` -ports: - - "3306:3306" -``` - - - - - -
## MySQL root access @@ -1682,7 +1668,7 @@ Enabling Global Composer Install during the build for the container allows you t
-## Magento 2 authentication credential (composer install) +## Add authentication credential for Magento 2 1 - Open the `.env` file diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md index d4f6d544..f71661da 100644 --- a/DOCUMENTATION/content/getting-started/index.md +++ b/DOCUMENTATION/content/getting-started/index.md @@ -41,7 +41,7 @@ Note: If you are not using Git yet for your project, you can use `git clone` ins *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)* -Your folder structure should look like this: +2 - Make sure your folder structure should look like this: ``` + project-a @@ -52,7 +52,7 @@ Your folder structure should look like this: *(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).* -> **Now jump to the [Usage](#Usage) section.** +3 - Go to the [Usage](#Usage) section. ### A.2) Don't have a PHP project yet: @@ -86,7 +86,7 @@ APP_CODE_PATH_HOST=../project-z/ Make sure to replace `project-z` with your project folder name. -> **Now jump to the [Usage](#Usage) section.** +3 - Go to the [Usage](#Usage) section. @@ -127,7 +127,7 @@ You can rename the config files, project folders and domains as you like, just m 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`. -> **Now jump to the [Usage](#Usage) section.** +4 - Go to the [Usage](#Usage) section. @@ -213,7 +213,16 @@ Open your PHP project's `.env` file or whichever configuration file you are read DB_HOST=mysql ``` +You need to use the Laradock's default DB credentials which can be found in the `.env` file (ex: `MYSQL_USER=`). +Or you can change them and rebuild the container. + *If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
-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/`. +5 - Open your browser and visit your localhost address. + +If you followed the multiple projects setup, you can visit `http://project-1.test/` and `http://project-2.test/`. + +[http://localhost:8080](http://localhost:8080) + +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. diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md index 82e6ad9c..4874e437 100644 --- a/DOCUMENTATION/content/introduction/index.md +++ b/DOCUMENTATION/content/introduction/index.md @@ -5,9 +5,9 @@ weight: 1 --- +## Use Docker First - Then Learn About It Later - -A full PHP development environment for Docker. +Laradock is a PHP development environment that runs on Docker. Supports a variety of useful Docker Images, pre-configured to provide a wonderful PHP development environment. @@ -175,7 +175,7 @@ That's it! enjoy :) - Web IDE - **Miscellaneous:** - - Workspace: *(Laradock container that includes a rich set of pre-configured useful tools)* + - Workspace *(Laradock container that includes a rich set of pre-configured useful tools)* - `PHP CLI` - `Composer` - `Git`