You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DOCUMENTATION/_settings/content/contributing/index.md
+44-44Lines changed: 44 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,41 +7,53 @@ weight: 6
7
7
8
8
Your contribution is more than welcome.
9
9
10
-
## Got a Question or Problem?
10
+
## I have a Question/Problem
11
11
12
-
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).
12
+
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`) And you can still seek help on Gitter for it.
13
13
14
-
## Found an Issue?
15
-
If you find a bug in the source code or a mistake in the documentation, you can help us by
16
-
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
14
+
## I found an Issue
15
+
If have an issue or you found a typo in the documentation, you can help us by
16
+
opnening an [Issue](https://github.com/laradock/laradock/issues).
17
17
18
-
## Want a Feature?
19
-
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.
18
+
**Steps to do before opening an Issue:**
20
19
20
+
1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).
21
21
22
-
## Edit the documentation
22
+
2. Decide if the Issue belongs to this project or to [Docker](https://github.com/docker) itself! or even the tool you are using such as Nginx or MongoDB...
23
+
24
+
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
25
+
26
+
*This Help us to maximize the effort we can spend fixing issues and adding new
27
+
features, by not reporting duplicate issues.*
28
+
29
+
30
+
## I want a Feature
31
+
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself.
32
+
33
+
34
+
35
+
36
+
37
+
## I want to update the Documentation (Site)
23
38
24
39
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
25
40
26
41
27
-
1. Install [Hugo](https://gohugo.io/) on your machine.
28
-
2. Clone laradock.
29
-
3. Go to `/docs`.
30
-
4. Delete everything except the `_settings` folder & the `CNAME` file.
31
-
5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally.
32
-
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
33
-
7. In each secion there's an `index.md` file, that's the file you need to edit.
34
-
8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there.
35
-
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
36
-
10. Go back to the project root directory, commit and push..
42
+
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
43
+
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
44
+
3. Delete the `/docs` folder from the root.
45
+
4. When you finish editing, run the `hugo` command to generate the HTML docs (in the `/docs`).
37
46
47
+
### To Host the website locally
48
+
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
38
49
50
+
### Edit the sidebar
51
+
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
39
52
40
53
41
54
42
-
## Coding Guidelines
43
55
44
-
## Support new Software
56
+
## How to support new Software (Add new Container)
45
57
46
58
* Create folder with the software name.
47
59
@@ -53,30 +65,23 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
53
65
54
66
* Make sure you follow our commenting style.
55
67
56
-
* Add the software in the `Readme`.
68
+
* Add the software in the `Documentation`.
57
69
58
-
## Edit existing Software
70
+
## Edit existing Software (Edit a Container)
59
71
60
72
* Open the software (container) folder.
61
73
62
74
* Edit the files you want to update.
63
75
64
76
***Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
65
-
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.
66
-
67
-
* Make sure to update the `Readme` in case you made any changes.
77
+
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
68
78
69
-
## Issue/PR Submission Guidelines
79
+
* Make sure to update the `Documentation` in case you made any changes.
70
80
71
-
## Submitting an Issue
72
-
Before you submit your issue search the archive, maybe your question was already answered.
73
81
74
-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
75
-
Help us to maximize the effort we can spend fixing issues and adding new
76
-
features, by not reporting duplicate issues.
82
+
## Pull Request
77
83
78
-
79
-
## Before Submitting a Pull Request (PR)
84
+
### 1. Before Submitting a Pull Request (PR)
80
85
81
86
Always Test everything and make sure its working:
82
87
@@ -86,13 +91,13 @@ Always Test everything and make sure its working:
86
91
- Test running the container with some other containers in real app and see of everything is working fine.
87
92
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
88
93
- Testing building the container (docker-compose build container-name) with no errors.
89
-
- Test it in real App.
94
+
- Test it in a real App if possible.
90
95
91
96
92
-
## Submitting a PR
97
+
### 2. Submitting a PR
93
98
Consider the following guidelines:
94
99
95
-
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
100
+
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate efforts.
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.*
124
129
125
130
131
+
### 3. After your PR is merged
126
132
127
-
128
-
129
-
130
-
## After your PR is merged
131
-
132
-
After your pull request is merged, you can safely delete your branch and pull the changes
133
-
from the main (upstream) repository:
133
+
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
134
134
135
135
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
136
136
@@ -161,4 +161,4 @@ from the main (upstream) repository:
Copy file name to clipboardExpand all lines: DOCUMENTATION/_settings/content/documentation/index.md
+22-17Lines changed: 22 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,6 +176,11 @@ However to view the logs of all the other containers (MySQL, PHP-FPM,...) you ca
176
176
docker logs {container-name}
177
177
```
178
178
179
+
More [options](https://docs.docker.com/compose/reference/logs/)
180
+
181
+
```bash
182
+
docker logs -f {container-name}
183
+
```
179
184
180
185
181
186
@@ -329,7 +334,7 @@ For information on how to configure xDebug with your IDE and work it out, check
329
334
330
335
By installing xDebug, you are enabling it to run on startup by default.
331
336
332
-
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):
337
+
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):
333
338
334
339
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
335
340
- Start xDebug by default: `./xdebugPhpFpm start`.
@@ -381,10 +386,10 @@ It should be like this:
381
386
382
387
383
388
<br>
384
-
<aname="LaraDock-for-Production"></a>
385
-
## Prepare LaraDock for Production
389
+
<aname="Laradock-for-Production"></a>
390
+
## Prepare Laradock for Production
386
391
387
-
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 example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
392
+
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 example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
388
393
389
394
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:
390
395
@@ -439,7 +444,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
439
444
440
445
3 - Edit `docker-compose.yml` to Map the new application path:
441
446
442
-
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
447
+
By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.
443
448
444
449
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:
445
450
@@ -456,7 +461,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
456
461
cd my-cool-app
457
462
```
458
463
459
-
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file.
464
+
5 - Go back to the Laradock installation steps to see how to edit the `.env` file.
To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:
901
+
To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
897
902
898
903
1 - Open the `docker-compose.yml` file.
899
904
@@ -1198,7 +1203,7 @@ It should be like this:
1198
1203
<aname="Common-Aliases"></a>
1199
1204
<br>
1200
1205
## Common Terminal Aliases
1201
-
When you start your docker container, LaraDock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
1206
+
When you start your docker container, Laradock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
1202
1207
1203
1208
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
1204
1209
@@ -1292,10 +1297,10 @@ Remote debug Laravel web and phpunit tests.
1292
1297
1293
1298
1294
1299
<br>
1295
-
<aname="keep-tracking-LaraDock"></a>
1296
-
## Keep track of your LaraDock changes
1300
+
<aname="keep-tracking-Laradock"></a>
1301
+
## Keep track of your Laradock changes
1297
1302
1298
-
1. Fork the LaraDock repository.
1303
+
1. Fork the Laradock repository.
1299
1304
2. Use that fork as a submodule.
1300
1305
3. Commit all your changes to your fork.
1301
1306
4. Pull new stuff from the main repository from time to time.
@@ -1308,14 +1313,14 @@ Remote debug Laravel web and phpunit tests.
1308
1313
1309
1314
<br>
1310
1315
<aname="upgrading-laradock"></a>
1311
-
## Upgrading LaraDock
1316
+
## Upgrading Laradock
1312
1317
1313
-
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:
1318
+
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
1314
1319
1315
1320
1. Stop the docker VM `docker-machine stop {default}`
1316
1321
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
1317
-
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`)
1318
-
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
1322
+
3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
1323
+
4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
1319
1324
1320
1325
**Note:** If you face any problem with the last step above: rebuild all your containers
1321
1326
`docker-compose build --no-cache`
@@ -1454,4 +1459,4 @@ This error sometimes happens because your Laravel application isn't running on t
1454
1459
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.
1455
1460
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
1456
1461
* Option B
1457
-
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`
1462
+
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`
0 commit comments