ykxiao/laradock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update the docs

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-02-22 15:58:06 -05:00
parent 8e8020e8b0
commit e5fa629a64
20 changed files with 3406 additions and 3261 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/contributing/index.html
View File

@ -180,9 +180,9 @@
<a title="Introduction" href="http://laradock.io/">
<a title="Overview" href="http://laradock.io/">
Introduction
Overview
</a>
@ -198,9 +198,9 @@
<a title="Getting started" href="http://laradock.io/getting-started/">
<a title="Getting Started" href="http://laradock.io/getting-started/">
Getting started
Getting Started
</a>
@ -336,26 +336,26 @@
<h2 id="guidelines:d680e8a854a7cbad6d490c445cba2eba">Guidelines</h2>
<h2 id="guidelines">Guidelines</h2>
<p>Your contribution is more than welcome.</p>
<h3 id="got-a-question-or-problem:d680e8a854a7cbad6d490c445cba2eba">Got a Question or Problem?</h3>
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
<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:d680e8a854a7cbad6d490c445cba2eba">Found an Issue?</h3>
<h3 id="found-an-issue">Found an Issue?</h3>
<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>
<h3 id="want-a-feature:d680e8a854a7cbad6d490c445cba2eba">Want a Feature?</h3>
<h3 id="want-a-feature">Want a Feature?</h3>
<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="coding-guidelines:d680e8a854a7cbad6d490c445cba2eba">Coding Guidelines</h2>
<h2 id="coding-guidelines">Coding Guidelines</h2>
<h3 id="support-new-software:d680e8a854a7cbad6d490c445cba2eba">Support new Software</h3>
<h3 id="support-new-software">Support new Software</h3>
<ul>
<li><p>Create folder with the software name.</p></li>
@ -371,7 +371,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>
</ul>
<h3 id="edit-existing-software:d680e8a854a7cbad6d490c445cba2eba">Edit existing Software</h3>
<h3 id="edit-existing-software">Edit existing Software</h3>
<ul>
<li><p>Open the software (container) folder.</p></li>
@ -384,17 +384,17 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
</ul>
<h2 id="issue-pr-submission-guidelines:d680e8a854a7cbad6d490c445cba2eba">Issue/PR Submission Guidelines</h2>
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
<h3 id="submitting-an-issue:d680e8a854a7cbad6d490c445cba2eba">Submitting an Issue</h3>
<h3 id="submitting-an-issue">Submitting an Issue</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.
<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>
<h3 id="before-submitting-a-pull-request-pr:d680e8a854a7cbad6d490c445cba2eba">Before Submitting a Pull Request (PR)</h3>
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
<p>Always Test everything and make sure its working:</p>
@ -403,7 +403,7 @@ features, by not reporting duplicate issues.</p>
<li>Before editing anything:
<ul>
<li>Test building the container (docker-compose build --no-cache container-name) build with no cache first.</li>
<li>Test building the container (docker-compose build &ndash;no-cache container-name) build with no cache first.</li>
<li>Test running the container with some other containers in real app and see of everything is working fine.</li>
</ul></li>
<li>Now edit the container (edit section by section and test rebuilding the container after every edited section)
@ -414,12 +414,12 @@ features, by not reporting duplicate issues.</p>
</ul></li>
</ul>
<h3 id="submitting-a-pr:d680e8a854a7cbad6d490c445cba2eba">Submitting a PR</h3>
<h3 id="submitting-a-pr">Submitting a PR</h3>
<p>Consider the following guidelines:</p>
<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&rsquo;t want to duplicate effort.</p></li>
<li><p>Make your changes in a new git branch:</p>
@ -454,7 +454,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>
<h3 id="after-your-pr-is-merged:d680e8a854a7cbad6d490c445cba2eba">After your PR is merged</h3>
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
<p>After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:</p>
@ -483,7 +483,7 @@ from the main (upstream) repository:</p>
<p><br></p>
<h3 id="happy-coding:d680e8a854a7cbad6d490c445cba2eba">Happy Coding :)</h3>
<h3 id="happy-coding">Happy Coding :)</h3>
<aside class="copyright" role="note">

32
docs/contributing/index.xml
View File

@ -16,26 +16,26 @@
<guid>http://laradock.io/contributing/</guid>
<description>
&lt;h2 id=&#34;guidelines:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;guidelines&#34;&gt;Guidelines&lt;/h2&gt;
&lt;p&gt;Your contribution is more than welcome.&lt;/p&gt;
&lt;h3 id=&#34;got-a-question-or-problem:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Got a Question or Problem?&lt;/h3&gt;
&lt;h3 id=&#34;got-a-question-or-problem&#34;&gt;Got a Question or Problem?&lt;/h3&gt;
&lt;p&gt;If you have questions about how to use LaraDock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Question).&lt;/p&gt;
&lt;h3 id=&#34;found-an-issue:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Found an Issue?&lt;/h3&gt;
&lt;h3 id=&#34;found-an-issue&#34;&gt;Found an Issue?&lt;/h3&gt;
&lt;p&gt;If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;. Even better you can submit a Pull Request with a fix.&lt;/p&gt;
&lt;h3 id=&#34;want-a-feature:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Want a Feature?&lt;/h3&gt;
&lt;h3 id=&#34;want-a-feature&#34;&gt;Want a Feature?&lt;/h3&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.&lt;/p&gt;
&lt;h2 id=&#34;coding-guidelines:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Coding Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;coding-guidelines&#34;&gt;Coding Guidelines&lt;/h2&gt;
&lt;h3 id=&#34;support-new-software:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Support new Software&lt;/h3&gt;
&lt;h3 id=&#34;support-new-software&#34;&gt;Support new Software&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Create folder with the software name.&lt;/p&gt;&lt;/li&gt;
@ -51,7 +51,7 @@ submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&g
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Readme&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id=&#34;edit-existing-software:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Edit existing Software&lt;/h3&gt;
&lt;h3 id=&#34;edit-existing-software&#34;&gt;Edit existing Software&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Open the software (container) folder.&lt;/p&gt;&lt;/li&gt;
@ -64,17 +64,17 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Readme&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;issue-pr-submission-guidelines:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Issue/PR Submission Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;issue-pr-submission-guidelines&#34;&gt;Issue/PR Submission Guidelines&lt;/h2&gt;
&lt;h3 id=&#34;submitting-an-issue:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Submitting an Issue&lt;/h3&gt;
&lt;h3 id=&#34;submitting-an-issue&#34;&gt;Submitting an Issue&lt;/h3&gt;
&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered.&lt;/p&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&#39;t been reported, open a new issue.
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;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.&lt;/p&gt;
&lt;h3 id=&#34;before-submitting-a-pull-request-pr:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Before Submitting a Pull Request (PR)&lt;/h3&gt;
&lt;h3 id=&#34;before-submitting-a-pull-request-pr&#34;&gt;Before Submitting a Pull Request (PR)&lt;/h3&gt;
&lt;p&gt;Always Test everything and make sure its working:&lt;/p&gt;
@ -83,7 +83,7 @@ features, by not reporting duplicate issues.&lt;/p&gt;
&lt;li&gt;Before editing anything:
&lt;ul&gt;
&lt;li&gt;Test building the container (docker-compose build --no-cache container-name) build with no cache first.&lt;/li&gt;
&lt;li&gt;Test building the container (docker-compose build &amp;ndash;no-cache container-name) build with no cache first.&lt;/li&gt;
&lt;li&gt;Test running the container with some other containers in real app and see of everything is working fine.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;Now edit the container (edit section by section and test rebuilding the container after every edited section)
@ -94,12 +94,12 @@ features, by not reporting duplicate issues.&lt;/p&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id=&#34;submitting-a-pr:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Submitting a PR&lt;/h3&gt;
&lt;h3 id=&#34;submitting-a-pr&#34;&gt;Submitting a PR&lt;/h3&gt;
&lt;p&gt;Consider the following guidelines:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&#39;t want to duplicate effort.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate effort.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make your changes in a new git branch:&lt;/p&gt;
@ -134,7 +134,7 @@ git push origin my-fix-branch -f
&lt;p&gt;&lt;em&gt;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.&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;after-your-pr-is-merged:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;After your PR is merged&lt;/h3&gt;
&lt;h3 id=&#34;after-your-pr-is-merged&#34;&gt;After your PR is merged&lt;/h3&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:&lt;/p&gt;
@ -163,7 +163,7 @@ from the main (upstream) repository:&lt;/p&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;h3 id=&#34;happy-coding:d680e8a854a7cbad6d490c445cba2eba&#34;&gt;Happy Coding :)&lt;/h3&gt;
&lt;h3 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h3&gt;
</description>
</item>