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

add how to contribute to the docs

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-02-22 16:17:15 -05:00
parent e5fa629a64
commit f5b3c95068
5 changed files with 138 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/contributing/index.html
View File

@ -336,26 +336,41 @@
<h2 id="guidelines">Guidelines</h2>
<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>
<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
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>
<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>
<h3 id="support-new-software">Support new Software</h3>
<h2 id="support-new-software">Support new Software</h2>
<ul>
<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>
</ul>
<h3 id="edit-existing-software">Edit existing Software</h3>
<h2 id="edit-existing-software">Edit existing Software</h2>
<ul>
<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>
<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>
@ -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
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>
@ -414,7 +429,7 @@ features, by not reporting duplicate issues.</p>
</ul></li>
</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>
@ -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>
<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
from the main (upstream) repository:</p>
@ -483,7 +498,7 @@ from the main (upstream) repository:</p>
<p><br></p>
<h3 id="happy-coding">Happy Coding :)</h3>
<h2 id="happy-coding">Happy Coding :)</h2>
<aside class="copyright" role="note">