From aedc7c8438459fc299b4b38ca2a212bcf5032b80 Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Thu, 16 Mar 2017 19:28:01 -0400 Subject: [PATCH] edit the docs --- .../content/getting-started/index.md | 16 +++++------ docs/contributing/index.html | 11 ++++---- docs/contributing/index.xml | 11 ++++---- docs/getting-started/index.html | 17 +++++------ docs/getting-started/index.xml | 17 +++++------ docs/index.html | 28 ++++++++++--------- docs/index.xml | 28 ++++++++++--------- 7 files changed, 68 insertions(+), 60 deletions(-) diff --git a/DOCUMENTATION/_settings/content/getting-started/index.md b/DOCUMENTATION/_settings/content/getting-started/index.md index 05f9265f..1cd90791 100644 --- a/DOCUMENTATION/_settings/content/getting-started/index.md +++ b/DOCUMENTATION/_settings/content/getting-started/index.md @@ -50,12 +50,13 @@ git submodule add https://github.com/Laradock/laradock.git Your folder structure should look like this: ``` -- project1 - - laradock -- project2 - - laradock +- project-A + - laradock-A +- project-B + - laradock-B ``` +(It's important to rename the folders differently in each project) ### A.2) Don't have a PHP project yet: @@ -70,12 +71,11 @@ git clone https://github.com/laradock/laradock.git Your folder structure should look like this: ``` -- projects - - laradock - - myProject +- laradock +- Project-Z ``` -2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../myProject:/var/www`). +2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../Project-Z:/var/www`). 3 - Stop and re-run your docker-compose command for the changes to take place. diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 7095c67f..311b1e14 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -346,16 +346,17 @@ features, by not reporting duplicate issues.

Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

    -
  1. Install Hugo on your machine (easy steps).
    2. -
  2. Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder is a section in the menu).
    3. -
  3. After done editing, run the this command hugo to generate the updated site inside the docs folder (It’s recommended to delete all files form the /docs folder, except the CNAME file, before running the hugo command).
    4. +
  4. Install Hugo on your machine (easy thing).
    5. +
  5. Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).
    6. +
  6. Delete the /docs folder from the root.
    7. +
  7. When you finish editing, run the hugo command to generate the HTML docs (in the /docs).
-

To Host the website locally

+

To Host the website locally

Go to DOCUMENTATION/_settings in your terminal and run hugo serve to host the website locally.

-

Edit the sidebar

+

Edit the sidebar

To add a new section to the sidebar or edit existing one, you need to edit this file DOCUMENTATION/_settings/config.toml.

diff --git a/docs/contributing/index.xml b/docs/contributing/index.xml index e3c69f3b..11e4e2c1 100644 --- a/docs/contributing/index.xml +++ b/docs/contributing/index.xml @@ -49,16 +49,17 @@ features, by not reporting duplicate issues.</em></p> <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 (easy steps).</li> -<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> -<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> +<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li> +<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> +<li>Delete the <code>/docs</code> folder from the root.</li> +<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li> </ol> -<h4 id="to-host-the-website-locally">To Host the website locally</h4> +<h3 id="to-host-the-website-locally">To Host the website locally</h3> <p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p> -<h4 id="edit-the-sidebar">Edit the sidebar</h4> +<h3 id="edit-the-sidebar">Edit the sidebar</h3> <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> diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 87c13b6a..9e8e8825 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -365,12 +365,14 @@

Your folder structure should look like this:

-
- project1
-	- laradock
-- project2
-	- laradock
+
- project-A
+	- laradock-A
+- project-B
+	- laradock-B
 

 
+
(It’s important to rename the folders differently in each project)

+
 

 
 
A.2) Don’t have a PHP project yet:

@@ -386,12 +388,11 @@
 
 
Your folder structure should look like this:

 
-
- projects
-	- laradock
-	- myProject
+
- laradock
+- Project-Z
 

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

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

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

 
diff --git a/docs/getting-started/index.xml b/docs/getting-started/index.xml
index 0516691f..0ab36543 100644
--- a/docs/getting-started/index.xml
+++ b/docs/getting-started/index.xml
@@ -68,12 +68,14 @@
 
 <p>Your folder structure should look like this:</p>
 
-<pre><code>- project1
-	- laradock
-- project2
-	- laradock
+<pre><code>- project-A
+	- laradock-A
+- project-B
+	- laradock-B
 </code></pre>
 
+<p>(It&rsquo;s important to rename the folders differently in each project)</p>
+
 <p><a name="A2"></a></p>
 
 <h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
@@ -89,12 +91,11 @@
 
 <p>Your folder structure should look like this:</p>
 
-<pre><code>- projects
-	- laradock
-	- myProject
+<pre><code>- laradock
+- Project-Z
 </code></pre>
 
-<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>
+<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>
 
 <p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
 
diff --git a/docs/index.html b/docs/index.html
index 2c4ca0b6..de0efabe 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -563,12 +563,14 @@ QUEUE_HOST=beanstalkd
 
 
Your folder structure should look like this:

 
-
- project1
-	- laradock
-- project2
-	- laradock
+
- project-A
+	- laradock-A
+- project-B
+	- laradock-B
 

 
+
(It’s important to rename the folders differently in each project)

+
 

 
 
A.2) Don’t have a PHP project yet:

@@ -584,12 +586,11 @@ QUEUE_HOST=beanstalkd
 
 
Your folder structure should look like this:

 
-
- projects
-	- laradock
-	- myProject
+
- laradock
+- Project-Z
 

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

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

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

 
@@ -1965,16 +1966,17 @@ features, by not reporting duplicate issues.

 
Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

 
 
    
-
  1. Install Hugo on your machine (easy steps).
    2. 
-
  2. Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder is a section in the menu).
    3. 
-
  3. After done editing, run the this command hugo to generate the updated site inside the docs folder (It’s recommended to delete all files form the /docs folder, except the CNAME file, before running the hugo command).
    4. 
+
  4. Install Hugo on your machine (easy thing).
    5. 
+
  5. Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).
    6. 
+
  6. Delete the /docs folder from the root.
    7. 
+
  7. When you finish editing, run the hugo command to generate the HTML docs (in the /docs).
    8. 
 

 
-
To Host the website locally

+
To Host the website locally

 
 
Go to DOCUMENTATION/_settings in your terminal and run hugo serve to host the website locally.

 
-
Edit the sidebar

+
Edit the sidebar

 
 
To add a new section to the sidebar or edit existing one, you need to edit this file DOCUMENTATION/_settings/config.toml.

 
diff --git a/docs/index.xml b/docs/index.xml
index 8c4953e6..0f55b4dc 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -270,12 +270,14 @@ QUEUE_HOST=beanstalkd
 
 <p>Your folder structure should look like this:</p>
 
-<pre><code>- project1
-	- laradock
-- project2
-	- laradock
+<pre><code>- project-A
+	- laradock-A
+- project-B
+	- laradock-B
 </code></pre>
 
+<p>(It&rsquo;s important to rename the folders differently in each project)</p>
+
 <p><a name="A2"></a></p>
 
 <h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
@@ -291,12 +293,11 @@ QUEUE_HOST=beanstalkd
 
 <p>Your folder structure should look like this:</p>
 
-<pre><code>- projects
-	- laradock
-	- myProject
+<pre><code>- laradock
+- Project-Z
 </code></pre>
 
-<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>
+<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>
 
 <p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
 
@@ -1692,16 +1693,17 @@ features, by not reporting duplicate issues.</em></p>
 <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 (easy steps).</li>
-<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>
-<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>
+<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
+<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>
+<li>Delete the <code>/docs</code> folder from the root.</li>
+<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li>
 </ol>
 
-<h4 id="to-host-the-website-locally">To Host the website locally</h4>
+<h3 id="to-host-the-website-locally">To Host the website locally</h3>
 
 <p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
 
-<h4 id="edit-the-sidebar">Edit the sidebar</h4>
+<h3 id="edit-the-sidebar">Edit the sidebar</h3>
 
 <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>