From e37fb6f094cf265934dd9d7a8a5ddfe8d7643d6f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 18 Jun 2017 18:57:34 +0200 Subject: [PATCH] Add FAQ (#2836) --- _config.yml | 2 ++ source/_faq/component.markdown | 16 ++++++++++++++++ source/_faq/distutils.markdown | 13 +++++++++++++ source/_faq/libyaml.markdown | 14 ++++++++++++++ source/_faq/pip.markdown | 18 ++++++++++++++++++ source/_faq/pip3.markdown | 22 ++++++++++++++++++++++ source/faq/index.markdown | 28 ++++++++++++++++++++++++++++ 7 files changed, 113 insertions(+) create mode 100644 source/_faq/component.markdown create mode 100644 source/_faq/distutils.markdown create mode 100644 source/_faq/libyaml.markdown create mode 100644 source/_faq/pip.markdown create mode 100644 source/_faq/pip3.markdown create mode 100644 source/faq/index.markdown diff --git a/_config.yml b/_config.yml index d0cf0b4ca15..a4e9bd59a8c 100644 --- a/_config.yml +++ b/_config.yml @@ -77,6 +77,8 @@ collections: output: true addons: output: true + faq: + output: true # ----------------------- # # 3rd Party Settings # diff --git a/source/_faq/component.markdown b/source/_faq/component.markdown new file mode 100644 index 00000000000..e0dc15363a7 --- /dev/null +++ b/source/_faq/component.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "Component" +description: "My component does not show up" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Configuration +--- + + +When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up. + +If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. diff --git a/source/_faq/distutils.markdown b/source/_faq/distutils.markdown new file mode 100644 index 00000000000..7b1819cbbbd --- /dev/null +++ b/source/_faq/distutils.markdown @@ -0,0 +1,13 @@ +--- +layout: page +title: "distutils" +description: "distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Installation +--- + +This is a known issue if you're on a Mac using Homebrew to install Python. Please follow [these instructions](https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user) to resolve it. diff --git a/source/_faq/libyaml.markdown b/source/_faq/libyaml.markdown new file mode 100644 index 00000000000..4f58a051058 --- /dev/null +++ b/source/_faq/libyaml.markdown @@ -0,0 +1,14 @@ +--- +layout: page +title: "libyaml" +description: "libyaml is not found or a compiler error" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +On a Debian system, install the Python 3 YAML library by `sudo apt-get install python3-yaml`. diff --git a/source/_faq/pip.markdown b/source/_faq/pip.markdown new file mode 100644 index 00000000000..6cb31f419f8 --- /dev/null +++ b/source/_faq/pip.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "pip" +description: "No module named pip" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +[Pip](https://pip.pypa.io/en/stable/) should come bundled with the latest Python 3 but is omitted by some distributions. If you are unable to run `python3 -m pip --version` you can install `pip` by [downloading the installer](https://bootstrap.pypa.io/get-pip.py) and running it with Python 3: + +```bash +$ python3 get-pip.py +``` diff --git a/source/_faq/pip3.markdown b/source/_faq/pip3.markdown new file mode 100644 index 00000000000..733336e296e --- /dev/null +++ b/source/_faq/pip3.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "pip3" +description: "pip3: command not found" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +This utility should have been installed as part of the Python 3.4 installation. Check if Python 3.4 is installed by running `python3 --version`. If it is not installed, [download it here](https://www.python.org/getit/). + +If you are able to successfully run `python3 --version` but not `pip3`, install Home Assistant by running the following command instead: + +```bash +$ python3 -m pip install homeassistant +``` + +On a Debian system, you can also install python3 by `sudo apt-get install python3`d and pip3 by `sudo apt-get install python3-pip`. diff --git a/source/faq/index.markdown b/source/faq/index.markdown new file mode 100644 index 00000000000..cfa67acbe0e --- /dev/null +++ b/source/faq/index.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "FAQ" +description: "Home Assistant' FAQ" +date: 2015-10-08 19:05 +sidebar: false +comments: false +sharing: true +footer: true +regenerate: true +hide_github_edit: true +--- + +This is a community curated list of frequently asked questions (FAQ) about the installation, setup, and usage of Home Assistant. + +{% assign faq = site.faq | sort: 'title' %} +{% assign categories = faq | map: 'ha_category' | uniq | sort %} + +{% for category in categories %} +## {% linkable_title {{ category }} %} + + {% for entry in faq %} + {% if entry.ha_category == category %} +### {% linkable_title {{ entry.description }} %} +{{entry.content}} + {% endif %} + {% endfor %} +{% endfor %}