Re-organisation Documentation and Getting started (#2055)

* Split MQTT documentation * Add more details * Move content to /docs * Enable sidebar * Move content to /docs * Enable sidebar * Move content * Update links * Remove wizard stuff * Enable sidebar * Minor changes * Move MQTT parts to /docs * update links * Update links and sync content * Fix link * Enable sidebar * Remove navigation * Remove navigation and other minor updates * Update links * Add overview page * Make title linkable * Update * Plit content * Update links * Rearrange content * New getting-started section * Add icons for docs * Update for new structure * Update for new structure * Add docs navigation * Add docs overview page * Remove ecosystem navigation * Add docs and remove other collections * Move ecosystem to docs * Remove duplicate files * Re-add ecosystem overview * Move to ecosystem * Fix permission * Update navigation * Remove collection * Move overview to right folder * Move mqtt to upper level * Move notebook to ecosystem * Remove un-used files * Add one more rectangle for iOS * Move two parts back from docs and rename Run step * Remove colon * update getting-started section * Add redirect * Update * Update navigation
2017-02-23 11:09:41 +01:00 · 2017-02-23 11:09:41 +01:00 · 481320128f
commit 481320128f
parent 0677895b5b
138 changed files with 1309 additions and 909 deletions
--- a/source/_docs/ecosystem/notebooks/api.markdown
+++ b/source/_docs/ecosystem/notebooks/api.markdown
@ -0,0 +1,13 @@
+---
+layout: page
+title: "Home Assistant Python API"
+description: "Basic example how to work with the Home Assistant Python API in a Jupyter notebook."
+date: 2016-07-23 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+redirect_from: /ecosystem/notebooks/api/
+---
+
+The [Python API](/developers/python_api/) allows one to create [interactive notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/home-assistant-python-api.ipynb).
--- a/source/_docs/ecosystem/notebooks/database.markdown
+++ b/source/_docs/ecosystem/notebooks/database.markdown
@ -0,0 +1,13 @@
+---
+layout: page
+title: "Database"
+description: "Basic example how to work with stored Home Assistant information in a Jupyter notebook."
+date: 2016-07-23 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+redirect_from: /ecosystem/notebooks/database/
+---
+
+The [Database example](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-examples.ipynb) shows you the details about how you can work with stored values.
--- a/source/_docs/ecosystem/notebooks/graph.markdown
+++ b/source/_docs/ecosystem/notebooks/graph.markdown
@ -0,0 +1,13 @@
+---
+layout: page
+title: "Graph"
+description: "Basic example how to create a graph with a Jupyter notebook."
+date: 2016-07-23 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+redirect_from: /ecosystem/notebooks/graph/
+---
+
+For graphing this [Jupyter notebook](ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/graph-single-sensor.ipynb) should get you started.
--- a/source/_docs/ecosystem/notebooks/installation.markdown
+++ b/source/_docs/ecosystem/notebooks/installation.markdown
@ -0,0 +1,51 @@
+---
+layout: page
+title: "Installation"
+description: "Setup and first steps for Jupyter Notebooks and Home Assistant."
+date: 2016-07-23 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+redirect_from: /ecosystem/notebooks/installation/
+---
+
+To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider to run Jupyter in a [virtualenv](/getting-started/installation-virtualenv/).
+
+```bash
+$ pip3 install jupyter matplotlib
+```
+
+<p class='note warning'>
+Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks, install Home Assistant with `$ pip3 install homeassistant` as well.
+</p>
+
+Now you are able to start the application.
+
+```bash
+$ jupyter notebook
+[I 17:22:18.081 NotebookApp] Writing notebook server cookie secret to /run/user/1000/jupyter/notebook_cookie_secret
+[I 17:22:18.921 NotebookApp] Serving notebooks from local directory: /home/fabaff/home-assistant
+[I 17:22:18.921 NotebookApp] 0 active kernels 
+[I 17:22:18.921 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/
+[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
+```
+
+Open [http://localhost:8888/](http://localhost:8888/) in your browser. Press "New" -> "Python3" to open a new notebook.
+
+<p class='img'>
+  <img src='{{site_root}}/images/screenshots/jupyter-new.png' />
+</p>
+
+You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the icon. 
+
+<p class='img'>
+  <img src='{{site_root}}/images/screenshots/jupyter-notebook.png' />
+</p>
+
+The downloadable version of this notebook is available in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks/blob/master/first-notebook.ipynb).
+
+
+As you can see is the workflow very similar to working directly with a Python shell. One advantage is that you can go back and forth as you please and save your work.
+
+
--- a/source/_docs/ecosystem/notebooks/stats.markdown
+++ b/source/_docs/ecosystem/notebooks/stats.markdown
@ -0,0 +1,13 @@
+---
+layout: page
+title: "Statistics"
+description: "Basic example how to create basic statistics with a Jupyter notebook."
+date: 2016-10-03 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+redirect_from: /ecosystem/notebooks/stats/
+---
+
+The [Statistics notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-statistics.ipynb) gets you started if you want to create statistical analysis of your data.