Furher work on Doc

biva · Sep 5, 2016 · c7ed52f · c7ed52f
1 parent c77f222
commit c7ed52f
Show file tree

Hide file tree

Showing 6 changed files with 116 additions and 102 deletions.
diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md
diff --git a/docs/00_Getting_Started/00_Overview.md b/docs/00_Getting_Started/00_Overview.md
@@ -0,0 +1,99 @@
+Volumio is an headless audiophile music player, designed to play music with the highest possible fidelity. Volumio runs on most embedded devices (Raspberry Pi, UDOO, Odroid, Cubieboard, Beaglebone...) and on any ordinary PC (x86).
+
+Volumio is obtained with 3 main components:
+
+* [Node.js Backend (this repository)](https://github.com/volumio/Volumio2/wiki)
+* [Angular.JS Frontend](https://github.com/volumio/Volumio2-UI)
+* [Debian based minimal OS ](https://github.com/volumio/Build)
+
+### Logins
+
+Logins
+* user : *volumio*
+
+* Password : *volumio*
+
+Root login has been disabled by default, however user volumio can become root.
+
+### Volumio 2 Virtual Machines
+
+Useful for fast developing, no need for a Raspberry Pi (also much faster)
+
+VMWARE Image is suggested, as Network configuration is tricky with Virtual Box
+
+* [VMWare Virtual Machine - Beta1](http://repo.volumio.org/Volumio2/DevTools/VolumioVM-VMWare.zip)
+* [Virtual Box Virtual Machine - Alpha5](http://repo.volumio.org/Volumio2/DevTools/VolumioVM-VirtualBox.zip)
+
+
+
+System Images built with [Volumio Builder](https://github.com/volumio/Build)
+
+## Preliminary Setup
+
+IMPORTANT NOTE:
+Volumio is designed to be an highly integrated system. This means that the WebUi is optimized to work along with the custom made Volumio system, and therefore it needs to run in a very tightly controlled environment. IT WON'T WORK on standard Raspbian or other non-volumio OSes. If you want to know what kind of customizations we're using, take a look at the [Volumio Builder](https://github.com/volumio/Build)
+
+
+Volumio works with 5.5.0 version of NodeJS. Reports of working\not working node version are appreciated!
+
+Clone the repo in the directory of your choice (default: /volumio)
+
+```shell
+git clone https://github.com/volumio/Volumio2.git volumio
+cd volumio
+```
+
+Make sure /volumio folder is owned volumio user
+
+```shell
+sudo chown -R volumio:volumio /volumio
+```
+
+And that /data folder exists and is owned by volumio user
+
+```shell
+sudo mkdir /data
+sudo chown -R volumio:volumio /data
+```
+
+All other dependecies are in the package JSON, from the working directory just run (as user volumio)
+
+```shell
+npm install
+```
+
+You can run all the servers in one single step just running with nodejs
+
+```shell
+node index.js
+```
+
+Finally, point your browser to http://(ip address):3000 to access the UI.
+
+A DEV Console is available at http://(ip address):3000/dev
+
+To make development more comfortable, a samba server is installed. This way the /volumio folder is accessible (and editable) via Network. Just mount it on your dev workstation and it will be available as local filesystem.
+Testing on PI is strongly suggested.
+
+Please take a look at the
+
+## Development 101
+
+To maximize efficiency and reduce code regression we're using [Git Workflow](https://guides.github.com/introduction/flow/). For example, to create a new feature you'll:
+* Create a new branch, named after the feature
+* Do your things on the branch
+* Test if everything is fine and we don't have regressions
+* Submit a Pull Request for branch dev
+
+
+All new improvements and developments are meant to be done on the dev branch, once it's declared stable it will be merged to master and deployed to happy Volumio users.
+
+
+## Development Guidelines
+
+* [Forum Threads](http://volumio.org/forum/discussion-t2098-10.html) for internal discussion, remember to subscribe topics.
+* Document your work where possible on the [Wiki](https://github.com/volumio/Volumio2/wiki).
+* This is intended to run on Low Power Devices (r-pi). Let's keep code efficient and lightweight.
+* To allow code mantainability, always comment your code properly and update DOCs if needed.
+* Adhere to [MVC Best Practices](http://www.yiiframework.com/doc/guide/1.1/en/basics.best-practices) to maximize project quality.
+* Have fun and enjoy what you're doing!
diff --git a/docs/_index.md b/docs/_index.md
@@ -1,104 +1,17 @@
-[![Join the chat at https://gitter.im/volumio/Volumio2](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/volumio/Volumio2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![dependencies](https://david-dm.org/volumio/Volumio2.svg)](https://david-dm.org/volumio/Volumio2)
-[![bitHound Dependencies](https://www.bithound.io/github/volumio/Volumio2/badges/dependencies.svg)](https://www.bithound.io/github/volumio/Volumio2/master/dependencies/npm)
-[![bitHound Score](https://www.bithound.io/github/volumio/Volumio2/badges/score.svg)](https://www.bithound.io/github/volumio/Volumio2)
+<div class="homelogo" style="display: block;margin: 0 auto;max-width:44%;"><img src ="https://cdn.volumio.org/wp-content/uploads/2016/09/volumio-header.png" /></div>
 
-Volumio is an headless audiophile music player, designed to play music with the highest possible fidelity. Volumio runs on most embedded devices (Raspberry Pi, UDOO, Odroid, Cubieboard, Beaglebone...) and on any ordinary PC (x86).
+&nbsp;
+#### Welcome to Volumio's documentation
 
-Volumio is obtained with 3 main components:
+Volumio is a GNU\Linux Based Audiophile Music Player Operating system. designed to play music with the highest possible fidelity. Altough its designed to run on most embedded devices (Raspberry Pi, UDOO, Odroid, Cubieboard, Beaglebone...) it works great also on any ordinary PC. To get more informations visit the [Overview section](/docs/Getting_Started/Overview).
 
-* [Node.js Backend (this repository)](https://github.com/volumio/Volumio2/wiki)
-* [Angular.JS Frontend](https://github.com/volumio/Volumio2-UI)
-* [Debian based minimal OS ](https://github.com/volumio/Build)
 
-### Logins
+#### Quick links
 
-Logins
-* user : *volumio*
+&nbsp;
 
-* Password : *volumio*
-
-Root login has been disabled by default, however user volumio can become root.
-
-### Volumio 2 Virtual Machines
-
-Useful for fast developing, no need for a Raspberry Pi (also much faster)
-
-VMWARE Image is suggested, as Network configuration is tricky with Virtual Box
-
-* [VMWare Virtual Machine - Beta1](http://repo.volumio.org/Volumio2/DevTools/VolumioVM-VMWare.zip)
-* [Virtual Box Virtual Machine - Alpha5](http://repo.volumio.org/Volumio2/DevTools/VolumioVM-VirtualBox.zip)
-
-
-
-System Images built with [Volumio Builder](https://github.com/volumio/Build)
-
-## Preliminary Setup
-
-IMPORTANT NOTE:
-Volumio is designed to be an highly integrated system. This means that the WebUi is optimized to work along with the custom made Volumio system, and therefore it needs to run in a very tightly controlled environment. IT WON'T WORK on standard Raspbian or other non-volumio OSes. If you want to know what kind of customizations we're using, take a look at the [Volumio Builder](https://github.com/volumio/Build)
-
-
-Volumio works with 5.5.0 version of NodeJS. Reports of working\not working node version are appreciated!
-
-Clone the repo in the directory of your choice (default: /volumio)
-
-```shell
-git clone https://github.com/volumio/Volumio2.git volumio
-cd volumio
-```
-
-Make sure /volumio folder is owned volumio user
-
-```shell
-sudo chown -R volumio:volumio /volumio
-```
-
-And that /data folder exists and is owned by volumio user
-
-```shell
-sudo mkdir /data
-sudo chown -R volumio:volumio /data
-```
-
-All other dependecies are in the package JSON, from the working directory just run (as user volumio)
-
-```shell
-npm install
-```
-
-You can run all the servers in one single step just running with nodejs
-
-```shell
-node index.js
-```
-
-Finally, point your browser to http://(ip address):3000 to access the UI.
-
-A DEV Console is available at http://(ip address):3000/dev
-
-To make development more comfortable, a samba server is installed. This way the /volumio folder is accessible (and editable) via Network. Just mount it on your dev workstation and it will be available as local filesystem.
-Testing on PI is strongly suggested.
-
-Please take a look at the
-
-## Development 101
-
-To maximize efficiency and reduce code regression we're using [Git Workflow](https://guides.github.com/introduction/flow/). For example, to create a new feature you'll:
-* Create a new branch, named after the feature
-* Do your things on the branch
-* Test if everything is fine and we don't have regressions
-* Submit a Pull Request for branch dev
-
-
-All new improvements and developments are meant to be done on the dev branch, once it's declared stable it will be merged to master and deployed to happy Volumio users.
-
-
-## Development Guidelines
-
-* [Forum Threads](http://volumio.org/forum/discussion-t2098-10.html) for internal discussion, remember to subscribe topics.
-* Document your work where possible on the [Wiki](https://github.com/volumio/Volumio2/wiki).
-* This is intended to run on Low Power Devices (r-pi). Let's keep code efficient and lightweight.
-* To allow code mantainability, always comment your code properly and update DOCs if needed.
-* Adhere to [MVC Best Practices](http://www.yiiframework.com/doc/guide/1.1/en/basics.best-practices) to maximize project quality.
-* Have fun and enjoy what you're doing!
+* Volumio uses Websockets to receive commands, see how it works in the [WebSocket API Section](/docs/API/WebSocket_APIs)
+* Learn how to write plugins to add new functionalities to Volumio in the [Plugin Section](/docs/Plugin_System)
+* Want to contribute to this guide? See the [Contribute to this doc Section](/docs/Good_to_Knows/Contribute_to_this_Doc)
+* Troubles mounting an NFS Share? See how to [Mount a NFS Share](/docs/Good_to_Knows/Mounting_an_NFS_Share)
+* Did you know that Volumio has a command line client? Here's how to use the  [Command Line Client](/docs/Good_to_Knows/Command_Line_Client)
diff --git a/docs/config.json b/docs/config.json
@@ -19,7 +19,7 @@
         "toggle_code": true,
         "date_modified": false,
         "float": false,
-         "auto_landing": true,
+         "auto_landing": false,
 
 
         "twitter": ["volumio"],

diff --git a/templates/home.php b/templates/home.php
@@ -73,9 +73,7 @@
     <div class="container">
 
             <div class="col-sm-8 col-sm-offset-1">
-                <?php if ($params['image']) {
-                    echo '<img class="homepage-image img-responsive" src="' . $params['image'] . '" alt="' . $params['title'] . '">';
-                } ?>
+
             </div>
         </div>
     </div>

diff --git a/themes/daux/css/volumiodocs.min.css b/themes/daux/css/volumiodocs.min.css
@@ -1059,3 +1059,7 @@ tbody tr:nth-child(even) td, tbody tr.even td {
 thead {
     color: black;
 }
+
+.page-header {
+    display: none;
+}