Docs for 0.20.0 (hacs#18)

* Docs for 0.20.0 * desc update * Add note about .translations * Updates * Test new * Adds descriptions * Populate descriptions * Fix build * not sure * add dummy blog post to fix builds * Fix redirects * Update demo
Jesus7502 · Dec 24, 2019 · d221cab · d221cab
1 parent fd1dba3
commit d221cab
Show file tree

Hide file tree

Showing 76 changed files with 590 additions and 174 deletions.
diff --git a/_redirects b/_redirects
@@ -0,0 +1 @@
+https://hacs.netlify.com/* https://hacs.xyz/:splat 301!
diff --git a/blog/dummy.md b/blog/dummy.md
diff --git a/documentation/basic/automation.md b/documentation/basic/automation.md
@@ -1,6 +1,7 @@
 ---
 id: automation
 title: Automation
+description: "Automations with HACS"
 ---
 
 Here are two simple automation examples of what you can do with the data that HACS provides:

diff --git a/documentation/basic/data.md b/documentation/basic/data.md
@@ -1,6 +1,7 @@
 ---
 id: data
 title: Data
+description: "HACS Data stores"
 ---
 
 All data it handles are saved to `hacs.*` files that is located under `.storage`
diff --git a/documentation/basic/events.md b/documentation/basic/events.md
@@ -1,6 +1,7 @@
 ---
 id: events
 title: Events
+description: "Events"
 ---
 
 When HACS operates it fires events for the frontend to listen to.

diff --git a/documentation/basic/existing_elements.md b/documentation/basic/existing_elements.md
@@ -1,6 +1,7 @@
 ---
 id: existing_elements
 title: Existing elements
+description: "Existing elements"
 ---
 
 HACS will not scan the local file system for existing elements.

diff --git a/documentation/basic/getting_started.md b/documentation/basic/getting_started.md
@@ -1,6 +1,7 @@
 ---
 id: getting_started
 title: Getting started
+description: "Getting started"
 ---
 
 ![hacsdemo](/img/demo.gif)

diff --git a/documentation/basic/logs.md b/documentation/basic/logs.md
@@ -1,6 +1,7 @@
 ---
 id: logs
 title: Logs
+description: "Logs"
 ---
 
 Like any other integration this logs to the `home-assistant.log` file.

diff --git a/documentation/basic/sensor.md b/documentation/basic/sensor.md
@@ -1,6 +1,7 @@
 ---
 id: sensor
 title: Sensor
+description: "HACS Sensor"
 ---
 
 During setup HACS will add a new sensor to your installation (`sensor.hacs`).

diff --git a/documentation/basic/startup.md b/documentation/basic/startup.md
@@ -1,6 +1,7 @@
 ---
 id: startup
 title: Startup
+description: "HACS Startup"
 ---
 
 During startup HACS will scan for known repositories, with a progress bar indicating that it's working.

diff --git a/documentation/basic/theming.md b/documentation/basic/theming.md
@@ -1,6 +1,7 @@
 ---
 id: theming
 title: Theming
+description: "Custom theme variables for HACS"
 ---
 
 HACS will try to match your Home Assistant theme as much as possible. There are also several variables you can use in your `themes.yaml` file to theme HACS further:

diff --git a/documentation/basic/updates.md b/documentation/basic/updates.md
@@ -1,6 +1,7 @@
 ---
 id: updates
 title: Updates
+description: "Data updates"
 ---
 
 ## Installed elements

diff --git a/documentation/categories/appdaemon_apps.md b/documentation/categories/appdaemon_apps.md
@@ -1,6 +1,7 @@
 ---
 id: appdaemon_apps
 title: AppDaemon Apps
+description: "Category: AppDaemon Apps"
 ---
 
 AppDaemon apps are apps for [AppDaemon](https://appdaemon.readthedocs.io/en/stable/)

diff --git a/documentation/categories/integrations.md b/documentation/categories/integrations.md
@@ -1,6 +1,7 @@
 ---
 id: integrations
 title: Integrations
+description: "Category: Integrations"
 ---
 
 Integrations in HACS (or custom_components as they are often referred to) are community-built integrations.

diff --git a/documentation/categories/plugins.md b/documentation/categories/plugins.md
@@ -1,6 +1,7 @@
 ---
 id: plugins
 title: Lovelace Plugins
+description: "Category: Lovelace Plugins"
 ---
 
 The [Lovelace UI](https://www.home-assistant.io/lovelace/) is a customizable interface. With additional community plugins you can extend the default Lovelace experience. 

diff --git a/documentation/categories/python_scripts.md b/documentation/categories/python_scripts.md
@@ -1,39 +1,14 @@
 ---
 id: python_scripts
 title: Python Scripts
+description: "Category: Python Scripts"
 ---
 
 Python Scripts is a part of the Home Assistant [`python_script` integration.](https://www.home-assistant.io/integrations/python_script/)
 
-Python Scripts is **not** enabled by default in HACS (this follows default Home Assistant behavior).
+Python Scripts in HACS will atomagically be enabled if you have it enabled in Home Assistant
 
-## Enable Python Scripts in HACS
-
-_There are 2 ways of doing this._
-
-### Enable if you used the UI to configure HACS
-
-Add a checkmark to the left of python_scripts in the UI configuration for HACS.
-
-![configuration](/img/conf4.png)
-
-[For more about configuring HACS with the UI have a look here](configuration/basic.md)
-
-### Enable if you used YAML to configure HACS
-
-If you used YAML to configure HACS, add this under your HACS configuration to enable Python Scripts:
-
-```yaml
-hacs:
- ...
- python_script: true
-```
-
-After adding that you need to restart Home Assistant.
-
-[For more about configuring HACS with YAML have a look here](configuration/legacy.md)
-
-## Python Scripts in Home Assistant
+## Enable Python Scripts in Home Assistant
 
 Add this to your `configuration.yaml`
 

diff --git a/documentation/categories/themes.md b/documentation/categories/themes.md
@@ -1,37 +1,12 @@
 ---
 id: themes
 title: Themes
+description: "Category: Themes"
 ---
 
 Themes is a part of the Home Assistant [`frontend` integration.](https://www.home-assistant.io/integrations/frontend/)
 
-Themes is **not** enabled by default in HACS (this follows default Home Assistant behavior)..
-
-## Enable themes in HACS
-
-_There are 2 ways of doing this._
-
-### Enable if you used the UI to configure HACS
-
-Add a checkmark to the left of themes in the UI configuration for HACS.
-
-![configuration](/img/conf4.png)
-
-[For more about configuring HACS with the UI have a look here](configuration/basic.md)
-
-### Enable if you used YAML to configure HACS
-
-If you used YAML to configure HACS, add this under your HACS configuration to enable themes:
-
-```yaml
-hacs:
- ...
- theme: true
-```
-
-After adding that you need to restart Home Assistant.
-
-[For more about configuring HACS with YAML have a look here](configuration/legacy.md)
+Themes in HACS will atomagically be enabled if you have it enabled in Home Assistant
 
 ## Enable themes in Home Assistant
 
@@ -45,3 +20,4 @@ frontend:
 ## Themes download location
 
 Any theme downloaded with HACS is stored in `themes/` in your Home Assistant configuration directory.
+
diff --git a/documentation/configuration/basic.md b/documentation/configuration/basic.md
@@ -1,6 +1,7 @@
 ---
 id: basic
 title: Initial Configuration
+description: "Basic configuration"
 ---
 
 _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_
@@ -29,8 +30,8 @@ Before HACS can show up in the list you need to clear your browser cache.
 - `Side panel title`: The name/title you want to display for HACS in the sidebar.
 - `Side panel icon`: The icon you want to display for HACS in the sidebar.
 - `Enable AppDaemon apps discovery & tracking`: Enables [AppDaemon](/docs/categories/appdaemon_apps)
-- `Enable python_scripts discovery & tracking`: Enables [Python Scripts](/docs/categories/python_scripts)
-- `Enable Themes discovery & tracking`: Enables [Themes](/docs/categories/themes)
+- `Enable python_scripts discovery & tracking`: [DEPRECATED!] Enables [Python Scripts](/docs/categories/python_scripts)
+- `Enable Themes discovery & tracking`: [DEPRECATED!] Enables [Themes](/docs/categories/themes)
 
 ## Click submit and wait for confirmation.
 

diff --git a/documentation/configuration/legacy.md b/documentation/configuration/legacy.md
@@ -2,6 +2,7 @@
 id: legacy
 title: Configure HACS with YAML
 sidebar_label: YAML (legacy)
+description: "Configure HACS with YAML (legacy)"
 ---
 
 _This page assume that you have already finished the [installation](/docs/installation/prerequisites)_
@@ -19,8 +20,8 @@ key | optional | default | description
 `sidepanel_title` | True | Community | The name used for the sidepanel link.
 `sidepanel_icon` | True | "mdi:alpha-c-box" | The icon used for the sidepanel link.
 `appdaemon` | True | `False` | Enable tracking of AppDaemon apps.
-`python_script` | True | `False` | Enable tracking of python scripts.
-`theme` | True | `False` | Enable tracking of themes.
+`python_script` | True | `False` | [DEPRECATED!] Enable tracking of python scripts.
+`theme` | True | `False` | [DEPRECATED!] Enable tracking of themes.
 `options` | True | | A map of options.
 
 ### Options (map)

diff --git a/documentation/configuration/options.md b/documentation/configuration/options.md
@@ -1,6 +1,7 @@
 ---
 id: options
 title: Configuration options
+description: "Configuration options"
 ---
 
 _This page assumes that you have already finished the [initial configuration](/docs/configuration/basic)_

diff --git a/documentation/configuration/pat.md b/documentation/configuration/pat.md
@@ -1,6 +1,7 @@
 ---
 id: pat
 title: Github Personal Access Token
+description: "Create Github Personal Access Token"
 ---
 
 In order to work, HACS needs to retrieve information about repositories using Github's API.

diff --git a/documentation/configuration/start.md b/documentation/configuration/start.md
@@ -1,6 +1,7 @@
 ---
 id: start
 title: Configuration
+description: "Configuration"
 ---
 
 _This page assumes you have already completed the [installation](/docs/installation/prerequisites)_

diff --git a/documentation/developer/backend.md b/documentation/developer/backend.md
@@ -1,6 +1,7 @@
 ---
 id: backend
 title: Backend
+description: "Backend development"
 ---
 
 This page should contain:

diff --git a/documentation/developer/devcontainer.md b/documentation/developer/devcontainer.md
@@ -1,6 +1,7 @@
 ---
 id: devcontainer
 title: Devcontainer
+description: "Set up devcontainer"
 ---
 
 [The easiest way to contribute is to spin up a devcontainer.](https://code.visualstudio.com/docs/remote/containers) with VSCode, it has all the tools you need included, and it does not interfare with your system.

diff --git a/documentation/developer/documentation.md b/documentation/developer/documentation.md
@@ -1,6 +1,7 @@
 ---
 id: documentation
 title: Documentation
+description: "Documentation development"
 ---
 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/ec224ba7-b3fb-4fc6-929e-991ba9801b53/deploy-status)](https://app.netlify.com/sites/hacs/deploys)
@@ -96,5 +97,6 @@ At the top of all pages you should have this:
 ---
 id: A ID for that file, ie. 'feature' (lowercase)
 title: A Title for the page, this will also be used in the sidebar, ie. Feature
+description: "A nice description here"
 ---
 ```
diff --git a/documentation/developer/frontend.md b/documentation/developer/frontend.md
@@ -1,21 +1,12 @@
 ---
 id: frontend
 title: Frontend
+description: "Frontend development"
 ---
 
 _All changes to the documentation should go against the `master` branch._ 
 The repository for the frontent is hosted @ https://github.com/hacs/frontend
 
-<pre class="prism-code language-bash codeBlock_19pQ">
- <h4>Note!</h4>
- Untill the new eperimental UI are default in HACS, you need to enable that to test your changes.
-</pre>
-
-<pre class="prism-code language-bash codeBlock_19pQ">
- <h4>Note!</h4>
- Contributions to the "old" UI will not be accepted.
-</pre>
-
 First spin up the [devcontainer](/docs/developer/devcontainer)
 
 When you have that running issue the following comands:

diff --git a/documentation/developer/maintainer.md b/documentation/developer/maintainer.md
@@ -1,6 +1,7 @@
 ---
 id: maintainer
 title: Maintainer
+description: "Maintainer tasks"
 ---
 
 This page should contain:

diff --git a/documentation/developer/start.md b/documentation/developer/start.md
@@ -1,6 +1,7 @@
 ---
 id: start
 title: Getting started
+description: "Getting started with HACS development"
 ---
 
 This integration is **massive** and there are a lot of areas to contribute to.

diff --git a/documentation/developer/translation.md b/documentation/developer/translation.md
@@ -1,6 +1,7 @@
 ---
 id: translation
 title: Translation
+description: "HACS Translations"
 ---
 
 To handle submissions of translated strings we are using [Lokalise](https://lokalise.com) they provide us with an amazing platform that is easy to use and maintain.
@@ -11,10 +12,10 @@ To help out with the translation of HACS you need an account on Lokalise, the ea
 
 When you have created your account [click here to join the HACS project on Lokalise.](https://lokalise.com/public/190570815d9461966ae081.06523141/)
 
-If you are unsure on how to proceed their documentation is really good, and you can [find that here.](https://docs.lokalise.com/en/) or send me a message @ discord (username: `ludeeus#4212`)
+If you are unsure on how to proceed their documentation is really good, and you can [find that here.](https://docs.lokalise.com/en/) or send me a message @ [discord](https://discord.gg/apgchf8) (username: `ludeeus#4212`)
 
-If you want to add translations for a language that is not listed please [open a FR here](https://github.com/custom-components/hacs/issues/new?template=feature_request.md)
+If you want to add translations for a language that is not listed please [open a FR here](https://github.com/hacs/frontend/issues/new)
 
 Before each release new translations are pulled from Lokalise, so if you have added something look for it in the next version of HACS.
 
-If you add elements to the UI of HACS that needs translations, update the [`strings.json`](https://github.com/custom-components/hacs/blob/master/custom_components/hacs/strings.json) file, when your PR are merged those new keys will be added to Lokalise ready to be translated.
+If you add elements to the UI of HACS that needs translations, update the [`en.json`](https://github.com/hacs/frontend/blob/master/src/localize/languages/en.json) file, when your PR are merged those new keys will be added to Lokalise ready to be translated.
diff --git a/documentation/faq/hassio_only.md b/documentation/faq/hassio_only.md
@@ -1,6 +1,7 @@
 ---
 id: hassio_only
 title: Is this for hass.io only?
+description: "NO, no, nope, this is for all Home Assistant installations (windows may have issues)"
 ---
 
 # No

diff --git a/documentation/faq/highlights.md b/documentation/faq/highlights.md
@@ -1,6 +1,7 @@
 ---
 id: highlights
 title: What HACS can do
+description: "TLDR;"
 ---
 
 In short: 

diff --git a/documentation/faq/installation.md b/documentation/faq/installation.md
@@ -1,6 +1,7 @@
 ---
 id: installation
 title: "How does it work: Installation"
+description: "How does it work: Installation"
 ---
 When you install an element this is what's happening:
 

diff --git a/documentation/faq/limitations.md b/documentation/faq/limitations.md
@@ -1,5 +1,6 @@
 ---
 id: limitations
 title: Known limitations
+description: "Known limitations"
 ---
 - If you install/upgrade/remove or add a custom repository while the background task is running, do **not** restart Home Assistant until that task is done, if you do your action will not be saved.
diff --git a/documentation/faq/upgrade.md b/documentation/faq/upgrade.md
@@ -1,5 +1,6 @@
 ---
 id: upgrade
 title: "How does it work: Upgrade"
+description: "How does it work: Upgrade"
 ---
 The same as installation.
diff --git a/documentation/faq/what.md b/documentation/faq/what.md
@@ -1,6 +1,7 @@
 ---
 id: what
 title: What is HACS?
+description: "What is HACS?"
 ---
 
 _Currently I have no idea what to write her..._