Skip to content

Commit aedc7c8

Browse files
MahmoudzMahmoudz
committed
edit the docs
1 parent ec4ccb4 commit aedc7c8

7 files changed

Lines changed: 68 additions & 60 deletions

File tree

‎DOCUMENTATION/_settings/content/getting-started/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,13 @@ git submodule add https://github.com/Laradock/laradock.git
5050
Your folder structure should look like this:
5151

5252
```
53-
- project1
54-
- laradock
55-
- project2
56-
- laradock
53+
- project-A
54+
- laradock-A
55+
- project-B
56+
- laradock-B
5757
```
5858

59+
(It's important to rename the folders differently in each project)
5960

6061
<a name="A2"></a>
6162
### A.2) Don't have a PHP project yet:
@@ -70,12 +71,11 @@ git clone https://github.com/laradock/laradock.git
7071
Your folder structure should look like this:
7172

7273
```
73-
- projects
74-
- laradock
75-
- myProject
74+
- laradock
75+
- Project-Z
7676
```
7777

78-
2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../myProject:/var/www`).
78+
2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../Project-Z:/var/www`).
7979

8080
3 - Stop and re-run your docker-compose command for the changes to take place.
8181

‎docs/contributing/index.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -346,16 +346,17 @@ <h2 id="i-want-to-update-the-documentation-site">I want to update the Documentat
346346
<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>
347347

348348
<ol>
349-
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
350-
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
351-
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It&rsquo;s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
349+
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
350+
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li>
351+
<li>Delete the <code>/docs</code> folder from the root.</li>
352+
<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li>
352353
</ol>
353354

354-
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
355+
<h3 id="to-host-the-website-locally">To Host the website locally</h3>
355356

356357
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
357358

358-
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
359+
<h3 id="edit-the-sidebar">Edit the sidebar</h3>
359360

360361
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
361362

‎docs/contributing/index.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,17 @@ features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
4949
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
5050

5151
&lt;ol&gt;
52-
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy steps).&lt;/li&gt;
53-
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder is a section in the menu).&lt;/li&gt;
54-
&lt;li&gt;After done editing, run the this command &lt;code&gt;hugo&lt;/code&gt; to generate the updated site inside the &lt;code&gt;docs&lt;/code&gt; folder (It&amp;rsquo;s recommended to delete all files form the &lt;code&gt;/docs&lt;/code&gt; folder, except the &lt;code&gt;CNAME&lt;/code&gt; file, before running the &lt;code&gt;hugo&lt;/code&gt; command).&lt;/li&gt;
52+
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
53+
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/li&gt;
54+
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
55+
&lt;li&gt;When you finish editing, run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (in the &lt;code&gt;/docs&lt;/code&gt;).&lt;/li&gt;
5556
&lt;/ol&gt;
5657

57-
&lt;h4 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h4&gt;
58+
&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
5859

5960
&lt;p&gt;Go to &lt;code&gt;DOCUMENTATION/_settings&lt;/code&gt; in your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/p&gt;
6061

61-
&lt;h4 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h4&gt;
62+
&lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
6263

6364
&lt;p&gt;To add a new section to the sidebar or edit existing one, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt;.&lt;/p&gt;
6465

‎docs/getting-started/index.html‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -365,12 +365,14 @@ <h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
365365

366366
<p>Your folder structure should look like this:</p>
367367

368-
<pre><code>- project1
369-
- laradock
370-
- project2
371-
- laradock
368+
<pre><code>- project-A
369+
- laradock-A
370+
- project-B
371+
- laradock-B
372372
</code></pre>
373373

374+
<p>(It&rsquo;s important to rename the folders differently in each project)</p>
375+
374376
<p><a name="A2"></a></p>
375377

376378
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
@@ -386,12 +388,11 @@ <h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project ye
386388

387389
<p>Your folder structure should look like this:</p>
388390

389-
<pre><code>- projects
390-
- laradock
391-
- myProject
391+
<pre><code>- laradock
392+
- Project-Z
392393
</code></pre>
393394

394-
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../myProject:/var/www</code>).</p>
395+
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../Project-Z:/var/www</code>).</p>
395396

396397
<p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
397398

‎docs/getting-started/index.xml‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@
6868

6969
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
7070

71-
&lt;pre&gt;&lt;code&gt;- project1
72-
- laradock
73-
- project2
74-
- laradock
71+
&lt;pre&gt;&lt;code&gt;- project-A
72+
- laradock-A
73+
- project-B
74+
- laradock-B
7575
&lt;/code&gt;&lt;/pre&gt;
7676

77+
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project)&lt;/p&gt;
78+
7779
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
7880

7981
&lt;h3 id=&#34;a-2-don-t-have-a-php-project-yet&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet:&lt;/h3&gt;
@@ -89,12 +91,11 @@
8991

9092
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
9193

92-
&lt;pre&gt;&lt;code&gt;- projects
93-
- laradock
94-
- myProject
94+
&lt;pre&gt;&lt;code&gt;- laradock
95+
- Project-Z
9596
&lt;/code&gt;&lt;/pre&gt;
9697

97-
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../myProject:/var/www&lt;/code&gt;).&lt;/p&gt;
98+
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../Project-Z:/var/www&lt;/code&gt;).&lt;/p&gt;
9899

99100
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;
100101

‎docs/index.html‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -563,12 +563,14 @@ <h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
563563

564564
<p>Your folder structure should look like this:</p>
565565

566-
<pre><code>- project1
567-
- laradock
568-
- project2
569-
- laradock
566+
<pre><code>- project-A
567+
- laradock-A
568+
- project-B
569+
- laradock-B
570570
</code></pre>
571571

572+
<p>(It&rsquo;s important to rename the folders differently in each project)</p>
573+
572574
<p><a name="A2"></a></p>
573575

574576
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
@@ -584,12 +586,11 @@ <h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project ye
584586

585587
<p>Your folder structure should look like this:</p>
586588

587-
<pre><code>- projects
588-
- laradock
589-
- myProject
589+
<pre><code>- laradock
590+
- Project-Z
590591
</code></pre>
591592

592-
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../myProject:/var/www</code>).</p>
593+
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../Project-Z:/var/www</code>).</p>
593594

594595
<p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
595596

@@ -1965,16 +1966,17 @@ <h2 id="i-want-to-update-the-documentation-site">I want to update the Documentat
19651966
<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>
19661967

19671968
<ol>
1968-
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</li>
1969-
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder is a section in the menu).</li>
1970-
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder (It&rsquo;s recommended to delete all files form the <code>/docs</code> folder, except the <code>CNAME</code> file, before running the <code>hugo</code> command).</li>
1969+
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
1970+
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li>
1971+
<li>Delete the <code>/docs</code> folder from the root.</li>
1972+
<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li>
19711973
</ol>
19721974

1973-
<h4 id="to-host-the-website-locally">To Host the website locally</h4>
1975+
<h3 id="to-host-the-website-locally">To Host the website locally</h3>
19741976

19751977
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
19761978

1977-
<h4 id="edit-the-sidebar">Edit the sidebar</h4>
1979+
<h3 id="edit-the-sidebar">Edit the sidebar</h3>
19781980

19791981
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
19801982

‎docs/index.xml‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,14 @@ QUEUE_HOST=beanstalkd
270270

271271
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
272272

273-
&lt;pre&gt;&lt;code&gt;- project1
274-
- laradock
275-
- project2
276-
- laradock
273+
&lt;pre&gt;&lt;code&gt;- project-A
274+
- laradock-A
275+
- project-B
276+
- laradock-B
277277
&lt;/code&gt;&lt;/pre&gt;
278278

279+
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project)&lt;/p&gt;
280+
279281
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
280282

281283
&lt;h3 id=&#34;a-2-don-t-have-a-php-project-yet&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet:&lt;/h3&gt;
@@ -291,12 +293,11 @@ QUEUE_HOST=beanstalkd
291293

292294
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
293295

294-
&lt;pre&gt;&lt;code&gt;- projects
295-
- laradock
296-
- myProject
296+
&lt;pre&gt;&lt;code&gt;- laradock
297+
- Project-Z
297298
&lt;/code&gt;&lt;/pre&gt;
298299

299-
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../myProject:/var/www&lt;/code&gt;).&lt;/p&gt;
300+
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../Project-Z:/var/www&lt;/code&gt;).&lt;/p&gt;
300301

301302
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;
302303

@@ -1692,16 +1693,17 @@ features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
16921693
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
16931694

16941695
&lt;ol&gt;
1695-
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy steps).&lt;/li&gt;
1696-
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder is a section in the menu).&lt;/li&gt;
1697-
&lt;li&gt;After done editing, run the this command &lt;code&gt;hugo&lt;/code&gt; to generate the updated site inside the &lt;code&gt;docs&lt;/code&gt; folder (It&amp;rsquo;s recommended to delete all files form the &lt;code&gt;/docs&lt;/code&gt; folder, except the &lt;code&gt;CNAME&lt;/code&gt; file, before running the &lt;code&gt;hugo&lt;/code&gt; command).&lt;/li&gt;
1696+
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
1697+
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/li&gt;
1698+
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
1699+
&lt;li&gt;When you finish editing, run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (in the &lt;code&gt;/docs&lt;/code&gt;).&lt;/li&gt;
16981700
&lt;/ol&gt;
16991701

1700-
&lt;h4 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h4&gt;
1702+
&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
17011703

17021704
&lt;p&gt;Go to &lt;code&gt;DOCUMENTATION/_settings&lt;/code&gt; in your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/p&gt;
17031705

1704-
&lt;h4 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h4&gt;
1706+
&lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
17051707

17061708
&lt;p&gt;To add a new section to the sidebar or edit existing one, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt;.&lt;/p&gt;
17071709

0 commit comments

Comments
 (0)