Skip to content

Commit badad15

Browse files
authored
Merge branch 'master' into add_apache_vhost_conf
2 parents 37ed904 + 9ae6e45 commit badad15

90 files changed

Lines changed: 2273 additions & 1825 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.env

Lines changed: 0 additions & 1 deletion
This file was deleted.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.idea
22
/logs
33
/data
4+
.env
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
baseurl = "http://laradock.io/"
22
languageCode = "en-us"
3-
publishDir = "../"
4-
title = "Laradock Docs"
3+
publishDir = "../../docs"
4+
title = "Laradock"
55
theme = "hugo-material-docs"
66
metadataformat = "yaml"
77
canonifyurls = true
@@ -15,8 +15,8 @@ googleAnalytics = "UA-37514928-9"
1515
copyright = ""
1616

1717
# Repository
18-
provider = "GitHub"
19-
repo_url = "https://github.com/laradock/laradock"
18+
provider = ""
19+
repo_url = ""
2020

2121
version = ""
2222
logo = ""
@@ -32,16 +32,16 @@ googleAnalytics = "UA-37514928-9"
3232
highlight_css = ""
3333

3434
[params.palette]
35-
primary = "purple"
36-
accent = "deep-purple"
35+
primary = "deep-purple"
36+
accent = "purple"
3737

3838
[params.font]
3939
text = "Doctarine"
4040
code = "Source Code Pro"
4141

4242
[social]
4343
twitter = ""
44-
github = "laradock"
44+
github = "laradock/laradock"
4545
email = ""
4646

4747
# ------- MENU START -----------------------------------------

docs/_settings/content/contributing/index.md renamed to DOCUMENTATION/_settings/content/contributing/index.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,53 @@ weight: 6
77

88
Your contribution is more than welcome.
99

10-
## Got a Question or Problem?
10+
## I have a Question/Problem
1111

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.
1313

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).
1717

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:**
2019

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).
2121

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)
2338

2439
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.
2540

2641

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`).
3746

47+
### To Host the website locally
48+
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
3849

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`.
3952

4053

4154

42-
## Coding Guidelines
4355

44-
## Support new Software
56+
## How to support new Software (Add new Container)
4557

4658
* Create folder with the software name.
4759

@@ -53,30 +65,23 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
5365

5466
* Make sure you follow our commenting style.
5567

56-
* Add the software in the `Readme`.
68+
* Add the software in the `Documentation`.
5769

58-
## Edit existing Software
70+
## Edit existing Software (Edit a Container)
5971

6072
* Open the software (container) folder.
6173

6274
* Edit the files you want to update.
6375

6476
* **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.
6878

69-
## Issue/PR Submission Guidelines
79+
* Make sure to update the `Documentation` in case you made any changes.
7080

71-
## Submitting an Issue
72-
Before you submit your issue search the archive, maybe your question was already answered.
7381

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
7783

78-
79-
## Before Submitting a Pull Request (PR)
84+
### 1. Before Submitting a Pull Request (PR)
8085

8186
Always Test everything and make sure its working:
8287

@@ -86,13 +91,13 @@ Always Test everything and make sure its working:
8691
- Test running the container with some other containers in real app and see of everything is working fine.
8792
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
8893
- 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.
9095

9196

92-
## Submitting a PR
97+
### 2. Submitting a PR
9398
Consider the following guidelines:
9499

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.
96101

97102
* Make your changes in a new git branch:
98103

@@ -123,14 +128,9 @@ git push origin my-fix-branch -f
123128
*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.*
124129

125130

131+
### 3. After your PR is merged
126132

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:
134134

135135
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
136136

@@ -161,4 +161,4 @@ from the main (upstream) repository:
161161

162162

163163
<br>
164-
## Happy Coding :)
164+
#### Happy Coding :)

docs/_settings/content/documentation/index.md renamed to DOCUMENTATION/_settings/content/documentation/index.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,11 @@ However to view the logs of all the other containers (MySQL, PHP-FPM,...) you ca
176176
docker logs {container-name}
177177
```
178178

179+
More [options](https://docs.docker.com/compose/reference/logs/)
180+
181+
```bash
182+
docker logs -f {container-name}
183+
```
179184

180185

181186

@@ -329,7 +334,7 @@ For information on how to configure xDebug with your IDE and work it out, check
329334

330335
By installing xDebug, you are enabling it to run on startup by default.
331336

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):
333338

334339
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
335340
- Start xDebug by default: `./xdebugPhpFpm start`.
@@ -381,10 +386,10 @@ It should be like this:
381386

382387

383388
<br>
384-
<a name="LaraDock-for-Production"></a>
385-
## Prepare LaraDock for Production
389+
<a name="Laradock-for-Production"></a>
390+
## Prepare Laradock for Production
386391

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 ...`).
388393

389394
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:
390395

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

440445
3 - Edit `docker-compose.yml` to Map the new application path:
441446

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.
443448

444449
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:
445450

@@ -456,7 +461,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
456461
cd my-cool-app
457462
```
458463

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.
460465

461466

462467

@@ -581,7 +586,7 @@ composer require predis/predis:^1.0
581586
5 - You can manually test it from Laravel with this code:
582587

583588
```php
584-
\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
589+
\Cache::store('redis')->put('Laradock', 'Awesome', 10);
585590
```
586591

587592

@@ -893,7 +898,7 @@ docker-compose up -d minio
893898
<a name="Install-CodeIgniter"></a>
894899
## Install CodeIgniter
895900

896-
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:
897902

898903
1 - Open the `docker-compose.yml` file.
899904

@@ -1198,7 +1203,7 @@ It should be like this:
11981203
<a name="Common-Aliases"></a>
11991204
<br>
12001205
## 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.
12021207

12031208
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
12041209

@@ -1292,10 +1297,10 @@ Remote debug Laravel web and phpunit tests.
12921297

12931298

12941299
<br>
1295-
<a name="keep-tracking-LaraDock"></a>
1296-
## Keep track of your LaraDock changes
1300+
<a name="keep-tracking-Laradock"></a>
1301+
## Keep track of your Laradock changes
12971302

1298-
1. Fork the LaraDock repository.
1303+
1. Fork the Laradock repository.
12991304
2. Use that fork as a submodule.
13001305
3. Commit all your changes to your fork.
13011306
4. Pull new stuff from the main repository from time to time.
@@ -1308,14 +1313,14 @@ Remote debug Laravel web and phpunit tests.
13081313

13091314
<br>
13101315
<a name="upgrading-laradock"></a>
1311-
## Upgrading LaraDock
1316+
## Upgrading Laradock
13121317

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.*:
13141319

13151320
1. Stop the docker VM `docker-machine stop {default}`
13161321
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`.
13191324

13201325
**Note:** If you face any problem with the last step above: rebuild all your containers
13211326
`docker-compose build --no-cache`
@@ -1454,4 +1459,4 @@ This error sometimes happens because your Laravel application isn't running on t
14541459
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.
14551460
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
14561461
* 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

Comments
 (0)