move the documentation markdown files outside the generated html folder
|
@ -0,0 +1 @@
|
||||||
|
laradock.io
|
|
@ -1,6 +1,6 @@
|
||||||
baseurl = "http://laradock.io/"
|
baseurl = "http://laradock.io/"
|
||||||
languageCode = "en-us"
|
languageCode = "en-us"
|
||||||
publishDir = "../"
|
publishDir = "../../docs"
|
||||||
title = "Laradock"
|
title = "Laradock"
|
||||||
theme = "hugo-material-docs"
|
theme = "hugo-material-docs"
|
||||||
metadataformat = "yaml"
|
metadataformat = "yaml"
|
|
@ -7,41 +7,52 @@ weight: 6
|
||||||
|
|
||||||
Your contribution is more than welcome.
|
Your contribution is more than welcome.
|
||||||
|
|
||||||
## Got a Question or Problem?
|
## I have a Question/Problem
|
||||||
|
|
||||||
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).
|
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.
|
||||||
|
|
||||||
## Found an Issue?
|
## I found an Issue
|
||||||
If you find a bug in the source code or a mistake in the documentation, you can help us by
|
If have an issue or you found a typo in the documentation, you can help us by
|
||||||
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
|
opnening an [Issue](https://github.com/laradock/laradock/issues).
|
||||||
|
|
||||||
## Want a Feature?
|
**Steps to do before opening an Issue:**
|
||||||
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.
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
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...
|
||||||
|
|
||||||
|
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
|
||||||
|
|
||||||
|
*This Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
|
features, by not reporting duplicate issues.*
|
||||||
|
|
||||||
|
|
||||||
## Update Documentation (Site)
|
## I want a Feature
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## I want to update the Documentation (Site)
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
1. Install [Hugo](https://gohugo.io/) on your machine.
|
1. Install [Hugo](https://gohugo.io/) on your machine (easy steps).
|
||||||
2. Clone laradock.
|
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder is a section in the menu).
|
||||||
3. Go to `/docs`.
|
3. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder (It's recommended to delete all files form the `/docs` folder, except the `CNAME` file, before running the `hugo` command).
|
||||||
4. Delete everything except the `_settings` folder & the `CNAME` file.
|
|
||||||
5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally.
|
#### To Host the website locally
|
||||||
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
|
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
|
||||||
7. In each section there's an `index.md` file, that's the file you need to edit.
|
|
||||||
8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there.
|
#### Edit the sidebar
|
||||||
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
|
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
|
||||||
10. Go back to the project root directory, commit and push..
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## How to support new Software (Add new Container)
|
||||||
## Coding Guidelines
|
|
||||||
|
|
||||||
## Support new Software
|
|
||||||
|
|
||||||
* Create folder with the software name.
|
* Create folder with the software name.
|
||||||
|
|
||||||
|
@ -53,9 +64,9 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
|
||||||
|
|
||||||
* Make sure you follow our commenting style.
|
* Make sure you follow our commenting style.
|
||||||
|
|
||||||
* Add the software in the `Readme`.
|
* Add the software in the `Documentation`.
|
||||||
|
|
||||||
## Edit existing Software
|
## Edit existing Software (Edit a Container)
|
||||||
|
|
||||||
* Open the software (container) folder.
|
* Open the software (container) folder.
|
||||||
|
|
||||||
|
@ -64,19 +75,12 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
|
||||||
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
|
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
|
||||||
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
|
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
|
||||||
|
|
||||||
* Make sure to update the `Readme` in case you made any changes.
|
* Make sure to update the `Documentation` in case you made any changes.
|
||||||
|
|
||||||
## Issue/PR Submission Guidelines
|
|
||||||
|
|
||||||
## Submitting an Issue
|
|
||||||
Before you submit your issue search the archive, maybe your question was already answered.
|
|
||||||
|
|
||||||
If your issue appears to be a bug, and hasn't been reported, open a new issue.
|
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
|
||||||
features, by not reporting duplicate issues.
|
|
||||||
|
|
||||||
|
|
||||||
## Before Submitting a Pull Request (PR)
|
## Pull Request
|
||||||
|
|
||||||
|
### 1. Before Submitting a Pull Request (PR)
|
||||||
|
|
||||||
Always Test everything and make sure its working:
|
Always Test everything and make sure its working:
|
||||||
|
|
||||||
|
@ -86,13 +90,13 @@ Always Test everything and make sure its working:
|
||||||
- Test running the container with some other containers in real app and see of everything is working fine.
|
- Test running the container with some other containers in real app and see of everything is working fine.
|
||||||
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
|
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
|
||||||
- Testing building the container (docker-compose build container-name) with no errors.
|
- Testing building the container (docker-compose build container-name) with no errors.
|
||||||
- Test it in real App.
|
- Test it in a real App if possible.
|
||||||
|
|
||||||
|
|
||||||
## Submitting a PR
|
### 2. Submitting a PR
|
||||||
Consider the following guidelines:
|
Consider the following guidelines:
|
||||||
|
|
||||||
* 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.
|
* 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.
|
||||||
|
|
||||||
* Make your changes in a new git branch:
|
* Make your changes in a new git branch:
|
||||||
|
|
||||||
|
@ -123,14 +127,9 @@ git push origin my-fix-branch -f
|
||||||
*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.*
|
*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.*
|
||||||
|
|
||||||
|
|
||||||
|
### 3. After your PR is merged
|
||||||
|
|
||||||
|
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
|
||||||
|
|
||||||
|
|
||||||
## After your PR is merged
|
|
||||||
|
|
||||||
After your pull request is merged, you can safely delete your branch and pull the changes
|
|
||||||
from the main (upstream) repository:
|
|
||||||
|
|
||||||
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
|
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
|
||||||
|
|
||||||
|
@ -161,4 +160,4 @@ from the main (upstream) repository:
|
||||||
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
## Happy Coding :)
|
#### Happy Coding :)
|
|
@ -26,12 +26,12 @@ Choose the setup the best suits your needs.
|
||||||
|
|
||||||
|
|
||||||
<a name="A"></a>
|
<a name="A"></a>
|
||||||
#### A) Setup for Single Project
|
### A) Setup for Single Project
|
||||||
> (Follow these steps if you want a separate Docker environment for each project)
|
> (Follow these steps if you want a separate Docker environment for each project)
|
||||||
|
|
||||||
|
|
||||||
<a name="A1"></a>
|
<a name="A1"></a>
|
||||||
##### A.1) Already have a PHP project:
|
### A.1) Already have a PHP project:
|
||||||
> (Follow these steps if you already have a PHP project, and all you need is an environment to run it)
|
> (Follow these steps if you already have a PHP project, and all you need is an environment to run it)
|
||||||
|
|
||||||
1 - Clone laradock on your project root directory:
|
1 - Clone laradock on your project root directory:
|
||||||
|
@ -58,7 +58,7 @@ Your folder structure should look like this:
|
||||||
|
|
||||||
|
|
||||||
<a name="A2"></a>
|
<a name="A2"></a>
|
||||||
##### A.2) Don't have a PHP project yet:
|
### A.2) Don't have a PHP project yet:
|
||||||
> (Follow these steps if you don't have a PHP project yet, and you need an environment to create the project)
|
> (Follow these steps if you don't have a PHP project yet, and you need an environment to create the project)
|
||||||
|
|
||||||
1 - Clone this repository anywhere on your machine:
|
1 - Clone this repository anywhere on your machine:
|
||||||
|
@ -84,7 +84,7 @@ docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....
|
||||||
```
|
```
|
||||||
|
|
||||||
<a name="B"></a>
|
<a name="B"></a>
|
||||||
#### B) Setup for Multiple Projects:
|
### B) Setup for Multiple Projects:
|
||||||
> (Follow these steps if you want a single Docker environment for all project)
|
> (Follow these steps if you want a single Docker environment for all project)
|
||||||
|
|
||||||
1 - Clone this repository anywhere on your machine:
|
1 - Clone this repository anywhere on your machine:
|
Before Width: | Height: | Size: 246 KiB After Width: | Height: | Size: 246 KiB |
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
Before Width: | Height: | Size: 254 KiB After Width: | Height: | Size: 254 KiB |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 145 KiB After Width: | Height: | Size: 145 KiB |
|
@ -315,39 +315,51 @@
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
|
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
|
||||||
|
|
||||||
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
|
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
|
||||||
|
|
||||||
<h2 id="found-an-issue">Found an Issue?</h2>
|
<h2 id="i-found-an-issue">I found an Issue</h2>
|
||||||
|
|
||||||
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
|
<p>If have an issue or you found a typo in the documentation, you can help us by
|
||||||
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
|
||||||
|
|
||||||
<h2 id="want-a-feature">Want a Feature?</h2>
|
<p><strong>Steps to do before opening an Issue:</strong></p>
|
||||||
|
|
||||||
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
|
<ol>
|
||||||
|
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
|
||||||
|
|
||||||
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
|
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB…</p></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>If your issue appears to be a bug, and hasn’t been reported, then open a new issue.</p>
|
||||||
|
|
||||||
|
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
|
features, by not reporting duplicate issues.</em></p>
|
||||||
|
|
||||||
|
<h2 id="i-want-a-feature">I want a Feature</h2>
|
||||||
|
|
||||||
|
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
|
||||||
|
|
||||||
|
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
|
||||||
|
|
||||||
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
|
||||||
<li>Clone laradock.</li>
|
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
|
||||||
<li>Go to <code>/docs</code>.</li>
|
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It’s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
|
||||||
<li>Delete everything except the <code>_settings</code> folder & the <code>CNAME</code> file.</li>
|
|
||||||
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
|
|
||||||
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
|
|
||||||
<li>In each section there’s an <code>index.md</code> file, that’s the file you need to edit.</li>
|
|
||||||
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
|
|
||||||
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
|
|
||||||
<li>Go back to the project root directory, commit and push..</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
|
||||||
|
|
||||||
<h2 id="support-new-software">Support new Software</h2>
|
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
|
||||||
|
|
||||||
|
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
|
||||||
|
|
||||||
|
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
|
||||||
|
|
||||||
|
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -360,10 +372,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
|
|
||||||
<li><p>Make sure you follow our commenting style.</p></li>
|
<li><p>Make sure you follow our commenting style.</p></li>
|
||||||
|
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Documentation</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="edit-existing-software">Edit existing Software</h2>
|
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -373,20 +385,12 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
||||||
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
||||||
|
|
||||||
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
|
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="pull-request">Pull Request</h2>
|
||||||
|
|
||||||
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
|
||||||
|
|
||||||
<p>If your issue appears to be a bug, and hasn’t been reported, open a new issue.
|
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
|
||||||
features, by not reporting duplicate issues.</p>
|
|
||||||
|
|
||||||
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
|
|
||||||
|
|
||||||
<p>Always Test everything and make sure its working:</p>
|
<p>Always Test everything and make sure its working:</p>
|
||||||
|
|
||||||
|
@ -402,16 +406,16 @@ features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
||||||
<li>Test it in real App.</li>
|
<li>Test it in a real App if possible.</li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don’t want to duplicate effort.</p></li>
|
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don’t want to duplicate efforts.</p></li>
|
||||||
|
|
||||||
<li><p>Make your changes in a new git branch:</p>
|
<li><p>Make your changes in a new git branch:</p>
|
||||||
|
|
||||||
|
@ -446,10 +450,9 @@ git push origin my-fix-branch -f
|
||||||
|
|
||||||
<p><em>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.</em></p>
|
<p><em>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.</em></p>
|
||||||
|
|
||||||
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
|
||||||
|
|
||||||
<p>After your pull request is merged, you can safely delete your branch and pull the changes
|
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
|
||||||
from the main (upstream) repository:</p>
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
||||||
|
@ -475,7 +478,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h2 id="happy-coding">Happy Coding :)</h2>
|
<h4 id="happy-coding">Happy Coding :)</h4>
|
||||||
|
|
||||||
|
|
||||||
<aside class="copyright" role="note">
|
<aside class="copyright" role="note">
|
||||||
|
|
|
@ -18,39 +18,51 @@
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
|
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
|
||||||
|
|
||||||
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
|
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
|
||||||
|
|
||||||
<h2 id="found-an-issue">Found an Issue?</h2>
|
<h2 id="i-found-an-issue">I found an Issue</h2>
|
||||||
|
|
||||||
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
|
<p>If have an issue or you found a typo in the documentation, you can help us by
|
||||||
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
|
||||||
|
|
||||||
<h2 id="want-a-feature">Want a Feature?</h2>
|
<p><strong>Steps to do before opening an Issue:</strong></p>
|
||||||
|
|
||||||
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
|
<ol>
|
||||||
|
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
|
||||||
|
|
||||||
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
|
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB&hellip;</p></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, then open a new issue.</p>
|
||||||
|
|
||||||
|
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
|
features, by not reporting duplicate issues.</em></p>
|
||||||
|
|
||||||
|
<h2 id="i-want-a-feature">I want a Feature</h2>
|
||||||
|
|
||||||
|
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
|
||||||
|
|
||||||
|
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
|
||||||
|
|
||||||
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
|
||||||
<li>Clone laradock.</li>
|
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
|
||||||
<li>Go to <code>/docs</code>.</li>
|
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It&rsquo;s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
|
||||||
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
|
|
||||||
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
|
|
||||||
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
|
|
||||||
<li>In each section there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
|
|
||||||
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
|
|
||||||
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
|
|
||||||
<li>Go back to the project root directory, commit and push..</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
|
||||||
|
|
||||||
<h2 id="support-new-software">Support new Software</h2>
|
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
|
||||||
|
|
||||||
|
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
|
||||||
|
|
||||||
|
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
|
||||||
|
|
||||||
|
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -63,10 +75,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
|
|
||||||
<li><p>Make sure you follow our commenting style.</p></li>
|
<li><p>Make sure you follow our commenting style.</p></li>
|
||||||
|
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Documentation</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="edit-existing-software">Edit existing Software</h2>
|
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -76,20 +88,12 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
||||||
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
||||||
|
|
||||||
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
|
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="pull-request">Pull Request</h2>
|
||||||
|
|
||||||
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
|
||||||
|
|
||||||
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
|
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
|
||||||
features, by not reporting duplicate issues.</p>
|
|
||||||
|
|
||||||
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
|
|
||||||
|
|
||||||
<p>Always Test everything and make sure its working:</p>
|
<p>Always Test everything and make sure its working:</p>
|
||||||
|
|
||||||
|
@ -105,16 +109,16 @@ features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
||||||
<li>Test it in real App.</li>
|
<li>Test it in a real App if possible.</li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li>
|
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate efforts.</p></li>
|
||||||
|
|
||||||
<li><p>Make your changes in a new git branch:</p>
|
<li><p>Make your changes in a new git branch:</p>
|
||||||
|
|
||||||
|
@ -149,10 +153,9 @@ git push origin my-fix-branch -f
|
||||||
|
|
||||||
<p><em>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.</em></p>
|
<p><em>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.</em></p>
|
||||||
|
|
||||||
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
|
||||||
|
|
||||||
<p>After your pull request is merged, you can safely delete your branch and pull the changes
|
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
|
||||||
from the main (upstream) repository:</p>
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
||||||
|
@ -178,7 +181,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h2 id="happy-coding">Happy Coding :)</h2>
|
<h4 id="happy-coding">Happy Coding :)</h4>
|
||||||
</description>
|
</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
|
|
@ -336,7 +336,7 @@
|
||||||
|
|
||||||
<p><a name="A"></a></p>
|
<p><a name="A"></a></p>
|
||||||
|
|
||||||
<h4 id="a-setup-for-single-project">A) Setup for Single Project</h4>
|
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
||||||
|
@ -344,7 +344,7 @@
|
||||||
|
|
||||||
<p><a name="A1"></a></p>
|
<p><a name="A1"></a></p>
|
||||||
|
|
||||||
<h5 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h5>
|
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
||||||
|
@ -373,7 +373,7 @@
|
||||||
|
|
||||||
<p><a name="A2"></a></p>
|
<p><a name="A2"></a></p>
|
||||||
|
|
||||||
<h5 id="a-2-don-t-have-a-php-project-yet">A.2) Don’t have a PHP project yet:</h5>
|
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don’t have a PHP project yet:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you don’t have a PHP project yet, and you need an environment to create the project)</p>
|
<p>(Follow these steps if you don’t have a PHP project yet, and you need an environment to create the project)</p>
|
||||||
|
@ -400,7 +400,7 @@
|
||||||
|
|
||||||
<p><a name="B"></a></p>
|
<p><a name="B"></a></p>
|
||||||
|
|
||||||
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
|
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
||||||
|
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
<p><a name="A"></a></p>
|
<p><a name="A"></a></p>
|
||||||
|
|
||||||
<h4 id="a-setup-for-single-project">A) Setup for Single Project</h4>
|
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
||||||
|
@ -47,7 +47,7 @@
|
||||||
|
|
||||||
<p><a name="A1"></a></p>
|
<p><a name="A1"></a></p>
|
||||||
|
|
||||||
<h5 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h5>
|
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
||||||
|
@ -76,7 +76,7 @@
|
||||||
|
|
||||||
<p><a name="A2"></a></p>
|
<p><a name="A2"></a></p>
|
||||||
|
|
||||||
<h5 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h5>
|
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you don&rsquo;t have a PHP project yet, and you need an environment to create the project)</p>
|
<p>(Follow these steps if you don&rsquo;t have a PHP project yet, and you need an environment to create the project)</p>
|
||||||
|
@ -103,7 +103,7 @@
|
||||||
|
|
||||||
<p><a name="B"></a></p>
|
<p><a name="B"></a></p>
|
||||||
|
|
||||||
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
|
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
||||||
|
|
|
@ -534,7 +534,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A"></a></p>
|
<p><a name="A"></a></p>
|
||||||
|
|
||||||
<h4 id="a-setup-for-single-project">A) Setup for Single Project</h4>
|
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
||||||
|
@ -542,7 +542,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A1"></a></p>
|
<p><a name="A1"></a></p>
|
||||||
|
|
||||||
<h5 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h5>
|
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
||||||
|
@ -571,7 +571,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A2"></a></p>
|
<p><a name="A2"></a></p>
|
||||||
|
|
||||||
<h5 id="a-2-don-t-have-a-php-project-yet">A.2) Don’t have a PHP project yet:</h5>
|
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don’t have a PHP project yet:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you don’t have a PHP project yet, and you need an environment to create the project)</p>
|
<p>(Follow these steps if you don’t have a PHP project yet, and you need an environment to create the project)</p>
|
||||||
|
@ -598,7 +598,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="B"></a></p>
|
<p><a name="B"></a></p>
|
||||||
|
|
||||||
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
|
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
||||||
|
@ -1929,39 +1929,51 @@ These Docker Compose projects have piqued our interest:</li>
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
|
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
|
||||||
|
|
||||||
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
|
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
|
||||||
|
|
||||||
<h2 id="found-an-issue">Found an Issue?</h2>
|
<h2 id="i-found-an-issue">I found an Issue</h2>
|
||||||
|
|
||||||
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
|
<p>If have an issue or you found a typo in the documentation, you can help us by
|
||||||
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
|
||||||
|
|
||||||
<h2 id="want-a-feature">Want a Feature?</h2>
|
<p><strong>Steps to do before opening an Issue:</strong></p>
|
||||||
|
|
||||||
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
|
<ol>
|
||||||
|
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
|
||||||
|
|
||||||
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
|
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB…</p></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>If your issue appears to be a bug, and hasn’t been reported, then open a new issue.</p>
|
||||||
|
|
||||||
|
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
|
features, by not reporting duplicate issues.</em></p>
|
||||||
|
|
||||||
|
<h2 id="i-want-a-feature">I want a Feature</h2>
|
||||||
|
|
||||||
|
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
|
||||||
|
|
||||||
|
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
|
||||||
|
|
||||||
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
|
||||||
<li>Clone laradock.</li>
|
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
|
||||||
<li>Go to <code>/docs</code>.</li>
|
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It’s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
|
||||||
<li>Delete everything except the <code>_settings</code> folder & the <code>CNAME</code> file.</li>
|
|
||||||
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
|
|
||||||
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
|
|
||||||
<li>In each section there’s an <code>index.md</code> file, that’s the file you need to edit.</li>
|
|
||||||
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
|
|
||||||
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
|
|
||||||
<li>Go back to the project root directory, commit and push..</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
|
||||||
|
|
||||||
<h2 id="support-new-software">Support new Software</h2>
|
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
|
||||||
|
|
||||||
|
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
|
||||||
|
|
||||||
|
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
|
||||||
|
|
||||||
|
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -1974,10 +1986,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
|
|
||||||
<li><p>Make sure you follow our commenting style.</p></li>
|
<li><p>Make sure you follow our commenting style.</p></li>
|
||||||
|
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Documentation</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="edit-existing-software">Edit existing Software</h2>
|
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -1987,20 +1999,12 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
||||||
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
||||||
|
|
||||||
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
|
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="pull-request">Pull Request</h2>
|
||||||
|
|
||||||
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
|
||||||
|
|
||||||
<p>If your issue appears to be a bug, and hasn’t been reported, open a new issue.
|
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
|
||||||
features, by not reporting duplicate issues.</p>
|
|
||||||
|
|
||||||
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
|
|
||||||
|
|
||||||
<p>Always Test everything and make sure its working:</p>
|
<p>Always Test everything and make sure its working:</p>
|
||||||
|
|
||||||
|
@ -2016,16 +2020,16 @@ features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
||||||
<li>Test it in real App.</li>
|
<li>Test it in a real App if possible.</li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don’t want to duplicate effort.</p></li>
|
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don’t want to duplicate efforts.</p></li>
|
||||||
|
|
||||||
<li><p>Make your changes in a new git branch:</p>
|
<li><p>Make your changes in a new git branch:</p>
|
||||||
|
|
||||||
|
@ -2060,10 +2064,9 @@ git push origin my-fix-branch -f
|
||||||
|
|
||||||
<p><em>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.</em></p>
|
<p><em>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.</em></p>
|
||||||
|
|
||||||
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
|
||||||
|
|
||||||
<p>After your pull request is merged, you can safely delete your branch and pull the changes
|
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
|
||||||
from the main (upstream) repository:</p>
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
||||||
|
@ -2089,7 +2092,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h2 id="happy-coding">Happy Coding :)</h2>
|
<h4 id="happy-coding">Happy Coding :)</h4>
|
||||||
|
|
||||||
|
|
||||||
<h1>License </h1>
|
<h1>License </h1>
|
||||||
|
|
|
@ -241,7 +241,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A"></a></p>
|
<p><a name="A"></a></p>
|
||||||
|
|
||||||
<h4 id="a-setup-for-single-project">A) Setup for Single Project</h4>
|
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
|
||||||
|
@ -249,7 +249,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A1"></a></p>
|
<p><a name="A1"></a></p>
|
||||||
|
|
||||||
<h5 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h5>
|
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
<p>(Follow these steps if you already have a PHP project, and all you need is an environment to run it)</p>
|
||||||
|
@ -278,7 +278,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="A2"></a></p>
|
<p><a name="A2"></a></p>
|
||||||
|
|
||||||
<h5 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h5>
|
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you don&rsquo;t have a PHP project yet, and you need an environment to create the project)</p>
|
<p>(Follow these steps if you don&rsquo;t have a PHP project yet, and you need an environment to create the project)</p>
|
||||||
|
@ -305,7 +305,7 @@ QUEUE_HOST=beanstalkd
|
||||||
|
|
||||||
<p><a name="B"></a></p>
|
<p><a name="B"></a></p>
|
||||||
|
|
||||||
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
|
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
|
||||||
|
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
<p>(Follow these steps if you want a single Docker environment for all project)</p>
|
||||||
|
@ -1656,39 +1656,51 @@ These Docker Compose projects have piqued our interest:</li>
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
|
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
|
||||||
|
|
||||||
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
|
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
|
||||||
|
|
||||||
<h2 id="found-an-issue">Found an Issue?</h2>
|
<h2 id="i-found-an-issue">I found an Issue</h2>
|
||||||
|
|
||||||
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
|
<p>If have an issue or you found a typo in the documentation, you can help us by
|
||||||
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
|
||||||
|
|
||||||
<h2 id="want-a-feature">Want a Feature?</h2>
|
<p><strong>Steps to do before opening an Issue:</strong></p>
|
||||||
|
|
||||||
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
|
<ol>
|
||||||
|
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
|
||||||
|
|
||||||
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
|
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB&hellip;</p></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, then open a new issue.</p>
|
||||||
|
|
||||||
|
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
|
features, by not reporting duplicate issues.</em></p>
|
||||||
|
|
||||||
|
<h2 id="i-want-a-feature">I want a Feature</h2>
|
||||||
|
|
||||||
|
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
|
||||||
|
|
||||||
|
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
|
||||||
|
|
||||||
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
|
||||||
<li>Clone laradock.</li>
|
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
|
||||||
<li>Go to <code>/docs</code>.</li>
|
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It&rsquo;s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
|
||||||
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
|
|
||||||
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
|
|
||||||
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
|
|
||||||
<li>In each section there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
|
|
||||||
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
|
|
||||||
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
|
|
||||||
<li>Go back to the project root directory, commit and push..</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
|
||||||
|
|
||||||
<h2 id="support-new-software">Support new Software</h2>
|
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
|
||||||
|
|
||||||
|
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
|
||||||
|
|
||||||
|
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
|
||||||
|
|
||||||
|
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -1701,10 +1713,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
|
|
||||||
<li><p>Make sure you follow our commenting style.</p></li>
|
<li><p>Make sure you follow our commenting style.</p></li>
|
||||||
|
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Documentation</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="edit-existing-software">Edit existing Software</h2>
|
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -1714,20 +1726,12 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
|
||||||
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
|
||||||
|
|
||||||
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
|
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="pull-request">Pull Request</h2>
|
||||||
|
|
||||||
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
|
||||||
|
|
||||||
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
|
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
|
||||||
features, by not reporting duplicate issues.</p>
|
|
||||||
|
|
||||||
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
|
|
||||||
|
|
||||||
<p>Always Test everything and make sure its working:</p>
|
<p>Always Test everything and make sure its working:</p>
|
||||||
|
|
||||||
|
@ -1743,16 +1747,16 @@ features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
|
||||||
<li>Test it in real App.</li>
|
<li>Test it in a real App if possible.</li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li>
|
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate efforts.</p></li>
|
||||||
|
|
||||||
<li><p>Make your changes in a new git branch:</p>
|
<li><p>Make your changes in a new git branch:</p>
|
||||||
|
|
||||||
|
@ -1787,10 +1791,9 @@ git push origin my-fix-branch -f
|
||||||
|
|
||||||
<p><em>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.</em></p>
|
<p><em>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.</em></p>
|
||||||
|
|
||||||
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
|
||||||
|
|
||||||
<p>After your pull request is merged, you can safely delete your branch and pull the changes
|
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
|
||||||
from the main (upstream) repository:</p>
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
|
||||||
|
@ -1816,7 +1819,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h2 id="happy-coding">Happy Coding :)</h2>
|
<h4 id="happy-coding">Happy Coding :)</h4>
|
||||||
</description>
|
</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
|