add how to contribute to the docs
This commit is contained in:
parent
e5fa629a64
commit
f5b3c95068
|
@ -5,25 +5,43 @@ weight: 6
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
## Guidelines
|
|
||||||
|
|
||||||
Your contribution is more than welcome.
|
Your contribution is more than welcome.
|
||||||
|
|
||||||
### Got a Question or Problem?
|
## Got a Question or 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).
|
||||||
|
|
||||||
### Found an Issue?
|
## Found an Issue?
|
||||||
If you find a bug in the source code or a mistake in the documentation, you can help us by
|
If you find a bug in the source code or a mistake 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.
|
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
|
||||||
|
|
||||||
### Want a Feature?
|
## 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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
## Edit the documentation
|
||||||
|
|
||||||
|
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.
|
||||||
|
2. Clone laradock.
|
||||||
|
3. Go to `/docs`.
|
||||||
|
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.
|
||||||
|
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
|
||||||
|
7. In each secion 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.
|
||||||
|
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
|
||||||
|
10. Go back to the project root directory, commit and push..
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Coding Guidelines
|
## Coding Guidelines
|
||||||
|
|
||||||
### Support new Software
|
## Support new Software
|
||||||
|
|
||||||
* Create folder with the software name.
|
* Create folder with the software name.
|
||||||
|
|
||||||
|
@ -37,7 +55,7 @@ You can request a new feature by submitting an [Issue](https://github.com/larado
|
||||||
|
|
||||||
* Add the software in the `Readme`.
|
* Add the software in the `Readme`.
|
||||||
|
|
||||||
### Edit existing Software
|
## Edit existing Software
|
||||||
|
|
||||||
* Open the software (container) folder.
|
* Open the software (container) folder.
|
||||||
|
|
||||||
|
@ -50,7 +68,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
|
|
||||||
## Issue/PR Submission Guidelines
|
## Issue/PR Submission Guidelines
|
||||||
|
|
||||||
### Submitting an Issue
|
## Submitting an Issue
|
||||||
Before you submit your issue search the archive, maybe your question was already answered.
|
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.
|
If your issue appears to be a bug, and hasn't been reported, open a new issue.
|
||||||
|
@ -58,7 +76,7 @@ Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
features, by not reporting duplicate issues.
|
features, by not reporting duplicate issues.
|
||||||
|
|
||||||
|
|
||||||
### Before Submitting a Pull Request (PR)
|
## Before Submitting a Pull Request (PR)
|
||||||
|
|
||||||
Always Test everything and make sure its working:
|
Always Test everything and make sure its working:
|
||||||
|
|
||||||
|
@ -71,7 +89,7 @@ Always Test everything and make sure its working:
|
||||||
- Test it in real App.
|
- Test it in real App.
|
||||||
|
|
||||||
|
|
||||||
### Submitting a PR
|
## 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 effort.
|
||||||
|
@ -109,7 +127,7 @@ git push origin my-fix-branch -f
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### After your PR is merged
|
## After your PR is merged
|
||||||
|
|
||||||
After your pull request is merged, you can safely delete your branch and pull the changes
|
After your pull request is merged, you can safely delete your branch and pull the changes
|
||||||
from the main (upstream) repository:
|
from the main (upstream) repository:
|
||||||
|
@ -143,4 +161,4 @@ from the main (upstream) repository:
|
||||||
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
### Happy Coding :)
|
## Happy Coding :)
|
||||||
|
|
|
@ -336,26 +336,41 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2 id="guidelines">Guidelines</h2>
|
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
|
<h2 id="got-a-question-or-problem">Got a Question or 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 Question).</p>
|
||||||
|
|
||||||
<h3 id="found-an-issue">Found an Issue?</h3>
|
<h2 id="found-an-issue">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 you find a bug in the source code or a mistake 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>
|
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
||||||
|
|
||||||
<h3 id="want-a-feature">Want a Feature?</h3>
|
<h2 id="want-a-feature">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 Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</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>
|
||||||
|
|
||||||
|
<h2 id="edit-the-documentation">Edit the documentation</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>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
||||||
|
<li>Clone laradock.</li>
|
||||||
|
<li>Go to <code>/docs</code>.</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 secion 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>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="support-new-software">Support new Software</h3>
|
<h2 id="support-new-software">Support new Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -371,7 +386,7 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="edit-existing-software">Edit existing Software</h3>
|
<h2 id="edit-existing-software">Edit existing Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -386,7 +401,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="submitting-an-issue">Submitting an Issue</h3>
|
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
||||||
|
|
||||||
|
@ -394,7 +409,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
features, by not reporting duplicate issues.</p>
|
features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
|
<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>
|
||||||
|
|
||||||
|
@ -414,7 +429,7 @@ features, by not reporting duplicate issues.</p>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="submitting-a-pr">Submitting a PR</h3>
|
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
|
@ -454,7 +469,7 @@ 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>
|
||||||
|
|
||||||
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
|
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
||||||
|
|
||||||
<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>
|
||||||
|
@ -483,7 +498,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h3 id="happy-coding">Happy Coding :)</h3>
|
<h2 id="happy-coding">Happy Coding :)</h2>
|
||||||
|
|
||||||
|
|
||||||
<aside class="copyright" role="note">
|
<aside class="copyright" role="note">
|
||||||
|
|
|
@ -16,26 +16,41 @@
|
||||||
<guid>http://laradock.io/contributing/</guid>
|
<guid>http://laradock.io/contributing/</guid>
|
||||||
<description>
|
<description>
|
||||||
|
|
||||||
<h2 id="guidelines">Guidelines</h2>
|
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
|
<h2 id="got-a-question-or-problem">Got a Question or 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 Question).</p>
|
||||||
|
|
||||||
<h3 id="found-an-issue">Found an Issue?</h3>
|
<h2 id="found-an-issue">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 you find a bug in the source code or a mistake 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>
|
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
||||||
|
|
||||||
<h3 id="want-a-feature">Want a Feature?</h3>
|
<h2 id="want-a-feature">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 Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</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>
|
||||||
|
|
||||||
|
<h2 id="edit-the-documentation">Edit the documentation</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>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
||||||
|
<li>Clone laradock.</li>
|
||||||
|
<li>Go to <code>/docs</code>.</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 secion 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>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="support-new-software">Support new Software</h3>
|
<h2 id="support-new-software">Support new Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -51,7 +66,7 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="edit-existing-software">Edit existing Software</h3>
|
<h2 id="edit-existing-software">Edit existing Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -66,7 +81,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="submitting-an-issue">Submitting an Issue</h3>
|
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
||||||
|
|
||||||
|
@ -74,7 +89,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
features, by not reporting duplicate issues.</p>
|
features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
|
<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>
|
||||||
|
|
||||||
|
@ -94,7 +109,7 @@ features, by not reporting duplicate issues.</p>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="submitting-a-pr">Submitting a PR</h3>
|
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
|
@ -134,7 +149,7 @@ 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>
|
||||||
|
|
||||||
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
|
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
||||||
|
|
||||||
<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>
|
||||||
|
@ -163,7 +178,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h3 id="happy-coding">Happy Coding :)</h3>
|
<h2 id="happy-coding">Happy Coding :)</h2>
|
||||||
</description>
|
</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
|
|
@ -1891,26 +1891,41 @@ These Docker Compose projects have piqued our interest:</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2 id="guidelines">Guidelines</h2>
|
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
|
<h2 id="got-a-question-or-problem">Got a Question or 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 Question).</p>
|
||||||
|
|
||||||
<h3 id="found-an-issue">Found an Issue?</h3>
|
<h2 id="found-an-issue">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 you find a bug in the source code or a mistake 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>
|
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
||||||
|
|
||||||
<h3 id="want-a-feature">Want a Feature?</h3>
|
<h2 id="want-a-feature">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 Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</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>
|
||||||
|
|
||||||
|
<h2 id="edit-the-documentation">Edit the documentation</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>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
||||||
|
<li>Clone laradock.</li>
|
||||||
|
<li>Go to <code>/docs</code>.</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 secion 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>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="support-new-software">Support new Software</h3>
|
<h2 id="support-new-software">Support new Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -1926,7 +1941,7 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="edit-existing-software">Edit existing Software</h3>
|
<h2 id="edit-existing-software">Edit existing Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -1941,7 +1956,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="submitting-an-issue">Submitting an Issue</h3>
|
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
||||||
|
|
||||||
|
@ -1949,7 +1964,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
features, by not reporting duplicate issues.</p>
|
features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
|
<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>
|
||||||
|
|
||||||
|
@ -1969,7 +1984,7 @@ features, by not reporting duplicate issues.</p>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="submitting-a-pr">Submitting a PR</h3>
|
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
|
@ -2009,7 +2024,7 @@ 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>
|
||||||
|
|
||||||
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
|
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
||||||
|
|
||||||
<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>
|
||||||
|
@ -2038,7 +2053,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h3 id="happy-coding">Happy Coding :)</h3>
|
<h2 id="happy-coding">Happy Coding :)</h2>
|
||||||
|
|
||||||
|
|
||||||
<h1>License </h1>
|
<h1>License </h1>
|
||||||
|
|
|
@ -1592,26 +1592,41 @@ These Docker Compose projects have piqued our interest:</li>
|
||||||
<guid>http://laradock.io/contributing/</guid>
|
<guid>http://laradock.io/contributing/</guid>
|
||||||
<description>
|
<description>
|
||||||
|
|
||||||
<h2 id="guidelines">Guidelines</h2>
|
|
||||||
|
|
||||||
<p>Your contribution is more than welcome.</p>
|
<p>Your contribution is more than welcome.</p>
|
||||||
|
|
||||||
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
|
<h2 id="got-a-question-or-problem">Got a Question or 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 Question).</p>
|
||||||
|
|
||||||
<h3 id="found-an-issue">Found an Issue?</h3>
|
<h2 id="found-an-issue">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 you find a bug in the source code or a mistake 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>
|
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
|
||||||
|
|
||||||
<h3 id="want-a-feature">Want a Feature?</h3>
|
<h2 id="want-a-feature">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 Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</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>
|
||||||
|
|
||||||
|
<h2 id="edit-the-documentation">Edit the documentation</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>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
|
||||||
|
<li>Clone laradock.</li>
|
||||||
|
<li>Go to <code>/docs</code>.</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 secion 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>
|
||||||
|
|
||||||
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
<h2 id="coding-guidelines">Coding Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="support-new-software">Support new Software</h3>
|
<h2 id="support-new-software">Support new Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Create folder with the software name.</p></li>
|
<li><p>Create folder with the software name.</p></li>
|
||||||
|
@ -1627,7 +1642,7 @@ submitting an <a href="https://github.com/laradock/laradock/issues"&g
|
||||||
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
<li><p>Add the software in the <code>Readme</code>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="edit-existing-software">Edit existing Software</h3>
|
<h2 id="edit-existing-software">Edit existing Software</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><p>Open the software (container) folder.</p></li>
|
<li><p>Open the software (container) folder.</p></li>
|
||||||
|
@ -1642,7 +1657,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
|
|
||||||
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
|
||||||
|
|
||||||
<h3 id="submitting-an-issue">Submitting an Issue</h3>
|
<h2 id="submitting-an-issue">Submitting an Issue</h2>
|
||||||
|
|
||||||
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
|
||||||
|
|
||||||
|
@ -1650,7 +1665,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
|
||||||
Help us to maximize the effort we can spend fixing issues and adding new
|
Help us to maximize the effort we can spend fixing issues and adding new
|
||||||
features, by not reporting duplicate issues.</p>
|
features, by not reporting duplicate issues.</p>
|
||||||
|
|
||||||
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
|
<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>
|
||||||
|
|
||||||
|
@ -1670,7 +1685,7 @@ features, by not reporting duplicate issues.</p>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="submitting-a-pr">Submitting a PR</h3>
|
<h2 id="submitting-a-pr">Submitting a PR</h2>
|
||||||
|
|
||||||
<p>Consider the following guidelines:</p>
|
<p>Consider the following guidelines:</p>
|
||||||
|
|
||||||
|
@ -1710,7 +1725,7 @@ 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>
|
||||||
|
|
||||||
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
|
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
|
||||||
|
|
||||||
<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>
|
||||||
|
@ -1739,7 +1754,7 @@ from the main (upstream) repository:</p>
|
||||||
|
|
||||||
<p><br></p>
|
<p><br></p>
|
||||||
|
|
||||||
<h3 id="happy-coding">Happy Coding :)</h3>
|
<h2 id="happy-coding">Happy Coding :)</h2>
|
||||||
</description>
|
</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue