Skip to content

Commit 4814490

Browse files
author
Mahmoudz
committed
enhance documentation readability
1 parent 4e257c8 commit 4814490

10 files changed

Lines changed: 729 additions & 709 deletions

File tree

.github/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
For basic sponsorships go to [Open Collective](https://opencollective.com/laradock#sponsor), for golden sponsorships contact <a href = "mailto: support@laradock.io">support@laradock.io</a>.
4444

45-
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.
45+
*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

4747
## Contributors
4848

@@ -71,18 +71,18 @@ Your logo will show up on the [github repository](https://github.com/laradock/la
7171
> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little.
7272
> Thanks in advance.
7373
74-
Donate directly via [Paypal](https://www.paypal.me/mzalt)
74+
Donate directly via [Paypal](https://paypal.me/mzmmzz)
7575

76-
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt)
77-
78-
or become a backer on [Open Collective](https://opencollective.com/laradock#backer)
79-
80-
<a href="https://opencollective.com/laradock#backers" target="_blank"><img src="https://opencollective.com/laradock/backers.svg?width=890"></a>
76+
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/mzmmzz)
8177

8278
or show your support via [Beerpay](https://beerpay.io/laradock/laradock)
8379

8480
[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock)
8581

82+
or become a backer on [Open Collective](https://opencollective.com/laradock#backer)
83+
84+
<a href="https://opencollective.com/laradock#backers" target="_blank"><img src="https://opencollective.com/laradock/backers.svg?width=890"></a>
85+
8686

8787
## License
8888

DOCUMENTATION/config.toml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,42 +48,42 @@ googleAnalytics = "UA-37514928-9"
4848
# ------- MENU START -----------------------------------------
4949

5050
[[menu.main]]
51-
name = "Introduction"
51+
name = "1. Introduction"
5252
url = "introduction/"
5353
weight = 1
5454

5555
[[menu.main]]
56-
name = "Getting Started"
56+
name = "2. Getting Started"
5757
url = "getting-started/"
5858
weight = 2
5959

6060
[[menu.main]]
61-
name = "Documentation"
61+
name = "3. Documentation"
6262
url = "documentation/"
6363
weight = 3
6464

6565
[[menu.main]]
66-
name = "Guides"
66+
name = "4. Guides"
6767
url = "guides/"
6868
weight = 4
6969

7070
[[menu.main]]
71-
name = "Help & Questions"
71+
name = "5. Help & Questions"
7272
url = "help/"
7373
weight = 5
7474

7575
[[menu.main]]
76-
name = "Related Projects"
76+
name = "6. Related Projects"
7777
url = "related-projects/"
7878
weight = 6
7979

8080
[[menu.main]]
81-
name = "Contributing"
81+
name = "7. Contributing"
8282
url = "contributing/"
8383
weight = 7
8484

8585
[[menu.main]]
86-
name = "License"
86+
name = "8. License"
8787
url = "license/"
8888
weight = 8
8989

DOCUMENTATION/content/contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Contributing
2+
title: 7. Contributing
33
type: index
44
weight: 7
55
---

DOCUMENTATION/content/documentation/index.md

Lines changed: 11 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Documentation
2+
title: 3. Documentation
33
type: index
44
weight: 3
55
---
@@ -320,21 +320,6 @@ PHP_FPM_INSTALL_PHPDBG=true
320320
```
321321

322322

323-
<a name="Setup remote debugging for PhpStorm on Linux"></a>
324-
## Setup remote debugging for PhpStorm on Linux
325-
326-
- Make sure you have followed the steps above in the [Install Xdebug section](#install-xdebug).
327-
328-
- Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration).
329-
330-
![Debug Configuration](/images/photos/PHPStorm/linux/configuration/debugConfiguration.png "Debug Configuration").
331-
332-
- Create a server with name `laradock` (matches **PHP_IDE_CONFIG** key in environment file) and make sure to map project root path with server correctly.
333-
334-
![Server Configuration](/images/photos/PHPStorm/linux/configuration/serverConfiguration.png "Server Configuration").
335-
336-
- Start listening for debug connections, place a breakpoint and you are good to go !
337-
338323

339324
<br>
340325
<a name="Control-xDebug"></a>
@@ -2029,22 +2014,6 @@ Remote debug Laravel web and phpunit tests.
20292014

20302015

20312016

2032-
<br>
2033-
<a name="upgrading-laradock"></a>
2034-
## Upgrading Laradock
2035-
2036-
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
2037-
2038-
1. Stop the docker VM `docker-machine stop {default}`
2039-
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
2040-
3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
2041-
4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
2042-
2043-
**Note:** If you face any problem with the last step above: rebuild all your containers
2044-
`docker-compose build --no-cache`
2045-
"Warning Containers Data might be lost!"
2046-
2047-
20482017

20492018

20502019

@@ -2212,126 +2181,17 @@ docker-compose up ...
22122181

22132182

22142183

2215-
2216-
2217-
2218-
<br>
2219-
<a name="Common-Problems"></a>
2220-
## Common Problems
2221-
2222-
*Here's a list of the common problems you might face, and the possible solutions.*
2223-
2224-
2225-
2226-
2227-
2228-
2229-
<br>
2230-
## I see a blank (white) page instead of the Laravel 'Welcome' page!
2231-
2232-
Run the following command from the Laravel root directory:
2233-
2234-
```bash
2235-
sudo chmod -R 777 storage bootstrap/cache
2236-
```
2237-
2238-
2239-
2240-
2241-
2242-
2243-
<br>
2244-
## I see "Welcome to nginx" instead of the Laravel App!
2245-
2246-
Use `http://127.0.0.1` instead of `http://localhost` in your browser.
2247-
2248-
2249-
2250-
2251-
2252-
2253-
<br>
2254-
## I see an error message containing `address already in use` or `port is already allocated`
2255-
2256-
Make sure the ports for the services that you are trying to run (22, 80, 443, 3306, etc.) are not being used already by other programs on the host, such as a built in `apache`/`httpd` service or other development tools you have installed.
2257-
2258-
2259-
2260-
2261-
2262-
2263-
<br>
2264-
## I get NGINX error 404 Not Found on Windows.
2265-
2266-
1. Go to docker Settings on your Windows machine.
2267-
2. Click on the `Shared Drives` tab and check the drive that contains your project files.
2268-
3. Enter your windows username and password.
2269-
4. Go to the `reset` tab and click restart docker.
2270-
2271-
2272-
2273-
2274-
2275-
2276-
<br>
2277-
## The time in my services does not match the current time
2278-
2279-
1. Make sure you've [changed the timezone](#Change-the-timezone).
2280-
2. Stop and rebuild the containers (`docker-compose up -d --build <services>`)
2281-
2282-
2283-
2284-
2285-
2286-
2287-
<br>
2288-
## I get MySQL connection refused
2289-
2290-
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:
2291-
2292-
* Option A
2293-
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.
2294-
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
2295-
* Option B
2296-
1. Change the `DB_HOST` value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as `mysql`
2297-
2298-
## I get stuck when building nginx on `fetch http://mirrors.aliyun.com/alpine/v3.5/main/x86_64/APKINDEX.tar.gz`
2299-
2300-
As stated on [#749](https://github.com/laradock/laradock/issues/749#issuecomment-419652646), Already fixed,just set `CHANGE_SOURCE` to false.
2301-
2302-
## Custom composer repo packagist url and npm registry url
2303-
2304-
In China, the origin source of composer and npm is very slow. You can add `WORKSPACE_NPM_REGISTRY` and `WORKSPACE_COMPOSER_REPO_PACKAGIST` config in `.env` to use your custom source.
2305-
2306-
Example:
2307-
```bash
2308-
WORKSPACE_NPM_REGISTRY=https://registry.npm.taobao.org
2309-
WORKSPACE_COMPOSER_REPO_PACKAGIST=https://packagist.phpcomposer.com
2310-
```
2311-
23122184
<br>
2185+
<a name="upgrade-laradock"></a>
2186+
## Upgrade Laradock
23132187

2314-
## I get `Module build failed: Error: write EPIPE` while compiling react application
2315-
2316-
When you run `npm build` or `yarn dev` building a react application using webpack with elixir you may receive a `Error: write EPIPE` while processing .jpg images.
2317-
2318-
This is caused of an outdated library for processing **.jpg files** in ubuntu 16.04.
2319-
2320-
To fix the problem you can follow those steps
2321-
2322-
1 - Open the `.env`.
2323-
2324-
2 - Search for `WORKSPACE_INSTALL_LIBPNG` or add the key if missing.
2325-
2326-
3 - Set the value to true:
2327-
2328-
```dotenv
2329-
WORKSPACE_INSTALL_LIBPNG=true
2330-
```
2331-
2332-
4 - Finally rebuild the workspace image
2188+
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
23332189

2334-
```bash
2335-
docker-compose build workspace
2336-
```
2190+
1. Stop the docker VM `docker-machine stop {default}`
2191+
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
2192+
3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
2193+
4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
23372194

2195+
**Note:** If you face any problem with the last step above: rebuild all your containers
2196+
`docker-compose build --no-cache`
2197+
"Warning Containers Data might be lost!"

DOCUMENTATION/content/getting-started/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
2-
title: Getting Started
2+
title: 2. Getting Started
33
type: index
44
weight: 2
55
---
66

7-
## Requirements
7+
## 2.1 Requirements
88

99
- [Git](https://git-scm.com/downloads)
1010
- [Docker](https://www.docker.com/products/docker/) `>= 17.12`
1111

1212

1313

1414

15-
16-
17-
18-
## Installation
15+
## 2.2 Installation
1916

2017
Choose the setup the best suits your needs.
2118

@@ -110,9 +107,11 @@ Your folder structure should look like this:
110107
+ project-2
111108
```
112109

113-
2 - Go to `nginx/sites` and create config files to point to different project directory when visiting different domains.
110+
2 - Go to your web server and create config files to point to different project directory when visiting different domains:
114111

115-
Laradock by default includes `app.conf.example`, `laravel.conf.example` and `symfony.conf.example` as working samples.
112+
For **Nginx** go to `nginx/sites`, for **Apache2** `apache2/sites`.
113+
114+
Laradock by default includes some sample files for you to copy `app.conf.example`, `laravel.conf.example` and `symfony.conf.example`.
116115

117116
3 - change the default names `*.conf`:
118117

@@ -125,6 +124,7 @@ You can rename the config files, project folders and domains as you like, just m
125124
127.0.0.1 project-2.test
126125
...
127126
```
127+
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

130130
> **Now jump to the [Usage](#Usage) section.**
@@ -136,7 +136,7 @@ If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https://
136136

137137

138138
<a name="Usage"></a>
139-
## Usage
139+
## 2.3 Usage
140140

141141
**Read Before starting:**
142142

0 commit comments

Comments
 (0)