Skip to content

Commit e5fa629

Browse files
committed
update the docs
1 parent 8e8020e commit e5fa629

20 files changed

Lines changed: 1077 additions & 932 deletions

File tree

docs/_settings/config.toml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,44 +47,44 @@ googleAnalytics = ""
4747
# ------- MENU START -----------------------------------------
4848

4949
[[menu.main]]
50-
name = "Introduction"
50+
name = "Overview"
5151
url = "/"
52-
weight = 0
52+
weight = 1
5353

5454
[[menu.main]]
55-
name = "Getting started"
55+
name = "Getting Started"
5656
url = "getting-started/"
57-
weight = 10
57+
weight = 2
5858

5959
[[menu.main]]
6060
name = "Documentation"
6161
url = "documentation/"
62-
weight = 20
62+
weight = 3
6363

6464
[[menu.main]]
6565
name = "Related Projects"
6666
url = "related-projects/"
67-
weight = 30
67+
weight = 4
6868

6969
[[menu.main]]
7070
name = "Help & Questions"
7171
url = "help/"
72-
weight = 40
72+
weight = 5
7373

7474
[[menu.main]]
7575
name = "Contributing"
7676
url = "contributing/"
77-
weight = 50
77+
weight = 6
7878

7979
[[menu.main]]
8080
name = "License"
8181
url = "license/"
82-
weight = 60
82+
weight = 7
8383

8484
# ------- MENU END -----------------------------------------
8585

8686
[blackfriday]
87-
smartypants = false
88-
fractions = false
89-
smartDashes = false
90-
plainIDAnchors = false
87+
smartypants = true
88+
fractions = true
89+
smartDashes = true
90+
plainIDAnchors = true

docs/_settings/content/contributing/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Contributing
33
type: index
4-
weight: 50
4+
weight: 6
55
---
66

77

@@ -143,4 +143,4 @@ from the main (upstream) repository:
143143

144144

145145
<br>
146-
### Happy Coding :)
146+
### Happy Coding :)

docs/_settings/content/documentation/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Documentation
33
type: index
4-
weight: 20
4+
weight: 3
55
---
66

77

@@ -1308,15 +1308,15 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ
13081308
## Improve speed on MacOS
13091309

13101310
Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.
1311-
1311+
13121312
> How to share files using NFS (d4m-nfs)
13131313
13141314
[d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
13151315

13161316
1) Update the Docker [File Sharing] preferences:
13171317

1318-
Click on the Docker Icon > Preferences > (remove everything form the list except `/tmp`).
1319-
1318+
Click on the Docker Icon > Preferences > (remove everything form the list except `/tmp`).
1319+
13201320
2) Restart Docker.
13211321

13221322
3) Clone the [d4m-nfs](https://github.com/IFSight/d4m-nfs) repository to your `home` directory.
@@ -1354,7 +1354,7 @@ docker-compose up -d nginx mysql
13541354

13551355
<br>
13561356
<a name="Common-Problems"></a>
1357-
## Common Problems
1357+
## Common Problems
13581358

13591359
*Here's a list of the common problems you might face, and the possible solutions.*
13601360

docs/_settings/content/getting-started/index.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
date: 2017
3-
title: Getting started
4-
weight: 10
2+
title: Getting Started
3+
type: index
4+
weight: 2
55
---
66

77

88

9-
10-
<a name="Requirements"></a>
119
## Requirements
1210

1311
- [Git](https://git-scm.com/downloads)
@@ -16,8 +14,6 @@ weight: 10
1614

1715

1816

19-
20-
<a name="Installation"></a>
2117
## Installation
2218

2319
Choose the setup the best suits your needs.
@@ -114,8 +110,6 @@ Do the same for each project `project2.conf`, `project3.conf`,...
114110

115111

116112

117-
118-
<a name="Usage"></a>
119113
## Usage
120114

121115
**Read Before starting:**
@@ -183,12 +177,3 @@ DB_HOST=mysql
183177

184178
If you need a special support. Contact me, more details in the [Help & Questions](#Help) section.
185179

186-
187-
188-
189-
190-
191-
192-
193-
194-

docs/_settings/content/help/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Help & Questions
33
type: index
4-
weight: 40
4+
weight: 5
55
---
66

77
Join the chat room on [Gitter](https://gitter.im/LaraDock/laradock) and get help and support from the community.

docs/_settings/content/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Welcome to Laradock
2+
title: Overview
33
type: index
4-
weight: 0
4+
weight: 1
55
---
66

77
LaraDock strives to make the PHP development experience easier and faster.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: License
33
type: index
4-
weight: 60
4+
weight: 7
55
---
66

77
[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)

docs/_settings/content/related-projects/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Related Projects
33
type: index
4-
weight: 30
4+
weight: 4
55
---
66

77

docs/contributing/index.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,9 @@
180180

181181

182182

183-
<a title="Introduction" href="http://laradock.io/">
183+
<a title="Overview" href="http://laradock.io/">
184184

185-
Introduction
185+
Overview
186186
</a>
187187

188188

@@ -198,9 +198,9 @@
198198

199199

200200

201-
<a title="Getting started" href="http://laradock.io/getting-started/">
201+
<a title="Getting Started" href="http://laradock.io/getting-started/">
202202

203-
Getting started
203+
Getting Started
204204
</a>
205205

206206

@@ -336,26 +336,26 @@ <h1>Contributing </h1>
336336

337337

338338

339-
<h2 id="guidelines:d680e8a854a7cbad6d490c445cba2eba">Guidelines</h2>
339+
<h2 id="guidelines">Guidelines</h2>
340340

341341
<p>Your contribution is more than welcome.</p>
342342

343-
<h3 id="got-a-question-or-problem:d680e8a854a7cbad6d490c445cba2eba">Got a Question or Problem?</h3>
343+
<h3 id="got-a-question-or-problem">Got a Question or Problem?</h3>
344344

345345
<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>
346346

347-
<h3 id="found-an-issue:d680e8a854a7cbad6d490c445cba2eba">Found an Issue?</h3>
347+
<h3 id="found-an-issue">Found an Issue?</h3>
348348

349349
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
350350
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
351351

352-
<h3 id="want-a-feature:d680e8a854a7cbad6d490c445cba2eba">Want a Feature?</h3>
352+
<h3 id="want-a-feature">Want a Feature?</h3>
353353

354354
<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>
355355

356-
<h2 id="coding-guidelines:d680e8a854a7cbad6d490c445cba2eba">Coding Guidelines</h2>
356+
<h2 id="coding-guidelines">Coding Guidelines</h2>
357357

358-
<h3 id="support-new-software:d680e8a854a7cbad6d490c445cba2eba">Support new Software</h3>
358+
<h3 id="support-new-software">Support new Software</h3>
359359

360360
<ul>
361361
<li><p>Create folder with the software name.</p></li>
@@ -371,7 +371,7 @@ <h3 id="support-new-software:d680e8a854a7cbad6d490c445cba2eba">Support new Softw
371371
<li><p>Add the software in the <code>Readme</code>.</p></li>
372372
</ul>
373373

374-
<h3 id="edit-existing-software:d680e8a854a7cbad6d490c445cba2eba">Edit existing Software</h3>
374+
<h3 id="edit-existing-software">Edit existing Software</h3>
375375

376376
<ul>
377377
<li><p>Open the software (container) folder.</p></li>
@@ -384,17 +384,17 @@ <h3 id="edit-existing-software:d680e8a854a7cbad6d490c445cba2eba">Edit existing S
384384
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
385385
</ul>
386386

387-
<h2 id="issue-pr-submission-guidelines:d680e8a854a7cbad6d490c445cba2eba">Issue/PR Submission Guidelines</h2>
387+
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
388388

389-
<h3 id="submitting-an-issue:d680e8a854a7cbad6d490c445cba2eba">Submitting an Issue</h3>
389+
<h3 id="submitting-an-issue">Submitting an Issue</h3>
390390

391391
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
392392

393-
<p>If your issue appears to be a bug, and hasn't been reported, open a new issue.
393+
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
394394
Help us to maximize the effort we can spend fixing issues and adding new
395395
features, by not reporting duplicate issues.</p>
396396

397-
<h3 id="before-submitting-a-pull-request-pr:d680e8a854a7cbad6d490c445cba2eba">Before Submitting a Pull Request (PR)</h3>
397+
<h3 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h3>
398398

399399
<p>Always Test everything and make sure its working:</p>
400400

@@ -403,7 +403,7 @@ <h3 id="before-submitting-a-pull-request-pr:d680e8a854a7cbad6d490c445cba2eba">Be
403403
<li>Before editing anything:
404404

405405
<ul>
406-
<li>Test building the container (docker-compose build --no-cache container-name) build with no cache first.</li>
406+
<li>Test building the container (docker-compose build &ndash;no-cache container-name) build with no cache first.</li>
407407
<li>Test running the container with some other containers in real app and see of everything is working fine.</li>
408408
</ul></li>
409409
<li>Now edit the container (edit section by section and test rebuilding the container after every edited section)
@@ -414,12 +414,12 @@ <h3 id="before-submitting-a-pull-request-pr:d680e8a854a7cbad6d490c445cba2eba">Be
414414
</ul></li>
415415
</ul>
416416

417-
<h3 id="submitting-a-pr:d680e8a854a7cbad6d490c445cba2eba">Submitting a PR</h3>
417+
<h3 id="submitting-a-pr">Submitting a PR</h3>
418418

419419
<p>Consider the following guidelines:</p>
420420

421421
<ul>
422-
<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>
422+
<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>
423423

424424
<li><p>Make your changes in a new git branch:</p>
425425

@@ -454,7 +454,7 @@ <h3 id="submitting-a-pr:d680e8a854a7cbad6d490c445cba2eba">Submitting a PR</h3>
454454

455455
<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>
456456

457-
<h3 id="after-your-pr-is-merged:d680e8a854a7cbad6d490c445cba2eba">After your PR is merged</h3>
457+
<h3 id="after-your-pr-is-merged">After your PR is merged</h3>
458458

459459
<p>After your pull request is merged, you can safely delete your branch and pull the changes
460460
from the main (upstream) repository:</p>
@@ -483,7 +483,7 @@ <h3 id="after-your-pr-is-merged:d680e8a854a7cbad6d490c445cba2eba">After your PR
483483

484484
<p><br></p>
485485

486-
<h3 id="happy-coding:d680e8a854a7cbad6d490c445cba2eba">Happy Coding :)</h3>
486+
<h3 id="happy-coding">Happy Coding :)</h3>
487487

488488

489489
<aside class="copyright" role="note">

0 commit comments

Comments
 (0)