Delet the _settings folder from the Documentation

2017-04-14 14:43:28 -04:00
1 parent 43ace2bebe
commit 919e0a75cd
@@ -7,13 +7,13 @@ install:
  - mv ./hugo_${HUGO_VERSION}_linux_amd64/hugo_${HUGO_VERSION}_linux_amd64 $HOME/bin/hugo
 script:
  - rm -rf docs
-  - cd DOCUMENTATION/_settings
+  - cd DOCUMENTATION
  - hugo

 deploy:
  provider: pages
  skip_cleanup: true
-  local_dir: ../../docs
+  local_dir: ../docs
  github_token: $GITHUB_TOKEN
  on:
    branch: master
@@ -1,6 +1,6 @@
 baseurl = "http://laradock.io/"
 languageCode = "en-us"
-publishDir = "../../docs"
+publishDir = "../docs"
 title = "Laradock"
 theme = "hugo-material-docs"
 metadataformat = "yaml"
@@ -38,11 +38,11 @@ You can request a new feature by submitting an [Issue](https://github.com/larado

 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.

-Go the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit
+Go the `DOCUMENTATION/content` and search for the markdown file you want to edit

 Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.

-To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/_settings/config.toml` toml file.
+To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file.

 > The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).

@@ -52,9 +52,9 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
 ### To Host the website locally

 1. Install [Hugo](https://gohugo.io/) on your machine.
-2. Edit the `DOCUMENTATION/_settings/content`.
+2. Edit the `DOCUMENTATION/content`.
 3. Delete the `/docs` folder from the root.
-4. After you finish the editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).
+4. After you finish the editing, go to `DOCUMENTATION/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).



@@ -363,19 +363,25 @@ 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>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</p>
+<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit</p>

-<p>To edit the sidebar or add a new section, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code> as well.</p>
+<p>Note: Every folder represents a section in the sidebar &ldquo;Menu&rdquo;. And every page and sidebar has a <code>weight</code> number to show it&rsquo;s position in the site.</p>

-<p><em>The site will be autogenerated in the <code>docs/</code> folder by <a href="https://travis-ci.com/">Travis</a>.</em></p>
+<p>To update the sidebar or add a new section to it, you can edit this <code>DOCUMENTATION/_settings/config.toml</code> toml file.</p>
+
+<blockquote>
+<p>The site will be auto-generated in the <code>docs/</code> folder by <a href="https://travis-ci.org/laradock/laradock/">Travis CI</a>.</p>
+</blockquote>
+
+<p><br></p>

 <h3 id="to-host-the-website-locally">To Host the website locally</h3>

 <ol>
-<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
+<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
 <li>Edit the <code>DOCUMENTATION/_settings/content</code>.</li>
 <li>Delete the <code>/docs</code> folder from the root.</li>
-<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
+<li>After you finish the editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside a new <code>/docs</code> folder).</li>
 </ol>

 <h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
@@ -48,19 +48,25 @@ 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;Go 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;/p&gt;
+&lt;p&gt;Go the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit&lt;/p&gt;

-&lt;p&gt;To edit the sidebar or add a new section, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt; as well.&lt;/p&gt;
+&lt;p&gt;Note: Every folder represents a section in the sidebar &amp;ldquo;Menu&amp;rdquo;. And every page and sidebar has a &lt;code&gt;weight&lt;/code&gt; number to show it&amp;rsquo;s position in the site.&lt;/p&gt;

-&lt;p&gt;&lt;em&gt;The site will be autogenerated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.com/&#34;&gt;Travis&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
+&lt;p&gt;To update the sidebar or add a new section to it, you can edit this &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt; toml file.&lt;/p&gt;
+
+&lt;blockquote&gt;
+&lt;p&gt;The site will be auto-generated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.org/laradock/laradock/&#34;&gt;Travis CI&lt;/a&gt;.&lt;/p&gt;
+&lt;/blockquote&gt;
+
+&lt;p&gt;&lt;br&gt;&lt;/p&gt;

 &lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&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 thing).&lt;/li&gt;
+&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
 &lt;li&gt;Edit the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt;.&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, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
+&lt;li&gt;After you finish the editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside a new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
 &lt;/ol&gt;

 &lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;
@@ -2697,19 +2697,25 @@ 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>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</p>
+<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit</p>

-<p>To edit the sidebar or add a new section, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code> as well.</p>
+<p>Note: Every folder represents a section in the sidebar &ldquo;Menu&rdquo;. And every page and sidebar has a <code>weight</code> number to show it&rsquo;s position in the site.</p>

-<p><em>The site will be autogenerated in the <code>docs/</code> folder by <a href="https://travis-ci.com/">Travis</a>.</em></p>
+<p>To update the sidebar or add a new section to it, you can edit this <code>DOCUMENTATION/_settings/config.toml</code> toml file.</p>
+
+<blockquote>
+<p>The site will be auto-generated in the <code>docs/</code> folder by <a href="https://travis-ci.org/laradock/laradock/">Travis CI</a>.</p>
+</blockquote>
+
+<p><br></p>

 <h3 id="to-host-the-website-locally">To Host the website locally</h3>

 <ol>
-<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
+<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
 <li>Edit the <code>DOCUMENTATION/_settings/content</code>.</li>
 <li>Delete the <code>/docs</code> folder from the root.</li>
-<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
+<li>After you finish the editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside a new <code>/docs</code> folder).</li>
 </ol>

 <h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
@@ -2411,19 +2411,25 @@ 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;Go 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;/p&gt;
+&lt;p&gt;Go the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit&lt;/p&gt;

-&lt;p&gt;To edit the sidebar or add a new section, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt; as well.&lt;/p&gt;
+&lt;p&gt;Note: Every folder represents a section in the sidebar &amp;ldquo;Menu&amp;rdquo;. And every page and sidebar has a &lt;code&gt;weight&lt;/code&gt; number to show it&amp;rsquo;s position in the site.&lt;/p&gt;

-&lt;p&gt;&lt;em&gt;The site will be autogenerated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.com/&#34;&gt;Travis&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
+&lt;p&gt;To update the sidebar or add a new section to it, you can edit this &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt; toml file.&lt;/p&gt;
+
+&lt;blockquote&gt;
+&lt;p&gt;The site will be auto-generated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.org/laradock/laradock/&#34;&gt;Travis CI&lt;/a&gt;.&lt;/p&gt;
+&lt;/blockquote&gt;
+
+&lt;p&gt;&lt;br&gt;&lt;/p&gt;

 &lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&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 thing).&lt;/li&gt;
+&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
 &lt;li&gt;Edit the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt;.&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, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
+&lt;li&gt;After you finish the editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside a new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
 &lt;/ol&gt;

 &lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;