You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_settings/content/contributing/index.md
+30-12Lines changed: 30 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,43 @@ weight: 6
5
5
---
6
6
7
7
8
-
## Guidelines
9
-
10
8
Your contribution is more than welcome.
11
9
12
-
###Got a Question or Problem?
10
+
## Got a Question or Problem?
13
11
14
12
If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
15
13
16
-
###Found an Issue?
14
+
## Found an Issue?
17
15
If you find a bug in the source code or a mistake in the documentation, you can help us by
18
16
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
19
17
20
-
###Want a Feature?
18
+
## Want a Feature?
21
19
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.
22
20
23
21
22
+
## Edit the documentation
23
+
24
+
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.
25
+
26
+
27
+
1. Install [Hugo](https://gohugo.io/) on your machine.
28
+
2. Clone laradock.
29
+
3. Go to `/docs`.
30
+
4. Delete everything except the `_settings` folder & the `CNAME` file.
31
+
5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally.
32
+
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
33
+
7. In each secion there's an `index.md` file, that's the file you need to edit.
34
+
8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there.
35
+
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
36
+
10. Go back to the project root directory, commit and push..
37
+
38
+
39
+
40
+
41
+
24
42
## Coding Guidelines
25
43
26
-
###Support new Software
44
+
## Support new Software
27
45
28
46
* Create folder with the software name.
29
47
@@ -37,7 +55,7 @@ You can request a new feature by submitting an [Issue](https://github.com/larado
37
55
38
56
* Add the software in the `Readme`.
39
57
40
-
###Edit existing Software
58
+
## Edit existing Software
41
59
42
60
* Open the software (container) folder.
43
61
@@ -50,15 +68,15 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info
50
68
51
69
## Issue/PR Submission Guidelines
52
70
53
-
###Submitting an Issue
71
+
## Submitting an Issue
54
72
Before you submit your issue search the archive, maybe your question was already answered.
55
73
56
74
If your issue appears to be a bug, and hasn't been reported, open a new issue.
57
75
Help us to maximize the effort we can spend fixing issues and adding new
58
76
features, by not reporting duplicate issues.
59
77
60
78
61
-
###Before Submitting a Pull Request (PR)
79
+
## Before Submitting a Pull Request (PR)
62
80
63
81
Always Test everything and make sure its working:
64
82
@@ -71,7 +89,7 @@ Always Test everything and make sure its working:
71
89
- Test it in real App.
72
90
73
91
74
-
###Submitting a PR
92
+
## Submitting a PR
75
93
Consider the following guidelines:
76
94
77
95
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Copy file name to clipboardExpand all lines: docs/contributing/index.html
+27-12Lines changed: 27 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -336,26 +336,41 @@ <h1>Contributing </h1>
336
336
337
337
338
338
339
-
<h2id="guidelines">Guidelines</h2>
340
-
341
339
<p>Your contribution is more than welcome.</p>
342
340
343
-
<h3id="got-a-question-or-problem">Got a Question or Problem?</h3>
341
+
<h2id="got-a-question-or-problem">Got a Question or Problem?</h2>
344
342
345
343
<p>If you have questions about how to use LaraDock, please direct your questions to the discussion on <ahref="https://gitter.im/LaraDock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <ahref="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
346
344
347
-
<h3id="found-an-issue">Found an Issue?</h3>
345
+
<h2id="found-an-issue">Found an Issue?</h2>
348
346
349
347
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
350
348
submitting an <ahref="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
351
349
352
-
<h3id="want-a-feature">Want a Feature?</h3>
350
+
<h2id="want-a-feature">Want a Feature?</h2>
353
351
354
352
<p>You can request a new feature by submitting an <ahref="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>
355
353
354
+
<h2id="edit-the-documentation">Edit the documentation</h2>
355
+
356
+
<p>Laradock uses <ahref="https://gohugo.io/">Hugo</a> as website generator tool, with the <ahref="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
357
+
358
+
<ol>
359
+
<li>Install <ahref="https://gohugo.io/">Hugo</a> on your machine.</li>
360
+
<li>Clone laradock.</li>
361
+
<li>Go to <code>/docs</code>.</li>
362
+
<li>Delete everything except the <code>_settings</code> folder & the <code>CNAME</code> file.</li>
363
+
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
364
+
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
365
+
<li>In each secion there’s an <code>index.md</code> file, that’s the file you need to edit.</li>
366
+
<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>
367
+
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
368
+
<li>Go back to the project root directory, commit and push..</li>
369
+
</ol>
370
+
356
371
<h2id="coding-guidelines">Coding Guidelines</h2>
357
372
358
-
<h3id="support-new-software">Support new Software</h3>
373
+
<h2id="support-new-software">Support new Software</h2>
359
374
360
375
<ul>
361
376
<li><p>Create folder with the software name.</p></li>
@@ -371,7 +386,7 @@ <h3 id="support-new-software">Support new Software</h3>
371
386
<li><p>Add the software in the <code>Readme</code>.</p></li>
@@ -454,7 +469,7 @@ <h3 id="submitting-a-pr">Submitting a PR</h3>
454
469
455
470
<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>
456
471
457
-
<h3id="after-your-pr-is-merged">After your PR is merged</h3>
472
+
<h2id="after-your-pr-is-merged">After your PR is merged</h2>
458
473
459
474
<p>After your pull request is merged, you can safely delete your branch and pull the changes
460
475
from the main (upstream) repository:</p>
@@ -483,7 +498,7 @@ <h3 id="after-your-pr-is-merged">After your PR is merged</h3>
<p>Your contribution is more than welcome.</p>
22
20
23
-
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
21
+
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
24
22
25
23
<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>
26
24
27
-
<h3 id="found-an-issue">Found an Issue?</h3>
25
+
<h2 id="found-an-issue">Found an Issue?</h2>
28
26
29
27
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
30
28
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
31
29
32
-
<h3 id="want-a-feature">Want a Feature?</h3>
30
+
<h2 id="want-a-feature">Want a Feature?</h2>
33
31
34
32
<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>
35
33
34
+
<h2 id="edit-the-documentation">Edit the documentation</h2>
35
+
36
+
<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>
37
+
38
+
<ol>
39
+
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
40
+
<li>Clone laradock.</li>
41
+
<li>Go to <code>/docs</code>.</li>
42
+
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
43
+
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
44
+
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
45
+
<li>In each secion there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
46
+
<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>
47
+
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
48
+
<li>Go back to the project root directory, commit and push..</li>
<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>
136
151
137
-
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
152
+
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
138
153
139
154
<p>After your pull request is merged, you can safely delete your branch and pull the changes
140
155
from the main (upstream) repository:</p>
@@ -163,7 +178,7 @@ from the main (upstream) repository:</p>
0 commit comments