blackbirdchess/blackbirdchess-docker-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

edit the docs

Browse Source
This commit is contained in:
Mahmoud Zalt 2017-03-16 19:28:01 -04:00
parent ec4ccb4a20
commit aedc7c8438
7 changed files with 68 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
DOCUMENTATION/_settings/content/getting-started/index.md
View File

@ -50,12 +50,13 @@ git submodule add https://github.com/Laradock/laradock.git
Your folder structure should look like this: Your folder structure should look like this:
``` ```
- project1 - project-A
- laradock - laradock-A
- project2 - project-B
- laradock - laradock-B
``` ```
(It's important to rename the folders differently in each project)
<a name="A2"></a> <a name="A2"></a>
### A.2) Don't have a PHP project yet: ### 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: Your folder structure should look like this:
``` ```
- projects - laradock
- laradock - Project-Z
- myProject
``` ```
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. 3 - Stop and re-run your docker-compose command for the changes to take place.

11
docs/contributing/index.html
View File

@ -346,16 +346,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> <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> <ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</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 is a section in the menu).</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>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>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> </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> <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> <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>

11
docs/contributing/index.xml
View File

@ -49,16 +49,17 @@ features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
&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; &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;
&lt;ol&gt; &lt;ol&gt;
&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; &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;
&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; &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;
&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; &lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&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;
&lt;/ol&gt; &lt;/ol&gt;
&lt;h4 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h4&gt; &lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
&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; &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;
&lt;h4 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h4&gt; &lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
&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; &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;

17
docs/getting-started/index.html
View File

@ -365,12 +365,14 @@
<p>Your folder structure should look like this:</p> <p>Your folder structure should look like this:</p>
<pre><code>- project1 <pre><code>- project-A
- laradock - laradock-A
- project2 - project-B
- laradock - laradock-B
</code></pre> </code></pre>
<p>(It&rsquo;s important to rename the folders differently in each project)</p>
<p><a name="A2"></a></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> <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 @@
<p>Your folder structure should look like this:</p> <p>Your folder structure should look like this:</p>
<pre><code>- projects <pre><code>- laradock
- laradock - Project-Z
- myProject
</code></pre> </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> <p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>

17
docs/getting-started/index.xml
View File

@ -68,12 +68,14 @@
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt; &lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- project1 &lt;pre&gt;&lt;code&gt;- project-A
- laradock - laradock-A
- project2 - project-B
- laradock - laradock-B
&lt;/code&gt;&lt;/pre&gt; &lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project)&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt; &lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&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; &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 @@
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt; &lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- projects &lt;pre&gt;&lt;code&gt;- laradock
- laradock - Project-Z
- myProject
&lt;/code&gt;&lt;/pre&gt; &lt;/code&gt;&lt;/pre&gt;
&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; &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;
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt; &lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;

28
docs/index.html
View File

@ -563,12 +563,14 @@ QUEUE_HOST=beanstalkd
<p>Your folder structure should look like this:</p> <p>Your folder structure should look like this:</p>
<pre><code>- project1 <pre><code>- project-A
- laradock - laradock-A
- project2 - project-B
- laradock - laradock-B
</code></pre> </code></pre>
<p>(It&rsquo;s important to rename the folders differently in each project)</p>
<p><a name="A2"></a></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> <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 @@ QUEUE_HOST=beanstalkd
<p>Your folder structure should look like this:</p> <p>Your folder structure should look like this:</p>
<pre><code>- projects <pre><code>- laradock
- laradock - Project-Z
- myProject
</code></pre> </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> <p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
@ -1965,16 +1966,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> <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> <ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy steps).</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 is a section in the menu).</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>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>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> </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> <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> <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>

28
docs/index.xml
View File

@ -270,12 +270,14 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt; &lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- project1 &lt;pre&gt;&lt;code&gt;- project-A
- laradock - laradock-A
- project2 - project-B
- laradock - laradock-B
&lt;/code&gt;&lt;/pre&gt; &lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project)&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt; &lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&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; &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
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt; &lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- projects &lt;pre&gt;&lt;code&gt;- laradock
- laradock - Project-Z
- myProject
&lt;/code&gt;&lt;/pre&gt; &lt;/code&gt;&lt;/pre&gt;
&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; &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;
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt; &lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;
@ -1692,16 +1693,17 @@ features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
&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; &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;
&lt;ol&gt; &lt;ol&gt;
&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; &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;
&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; &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;
&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; &lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&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;
&lt;/ol&gt; &lt;/ol&gt;
&lt;h4 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h4&gt; &lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
&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; &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;
&lt;h4 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h4&gt; &lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
&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; &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;