Initial commit after move

.devcontainer/devcontainer.json

@@ -0,0 +1,14 @@
+// For format details, see https://aka.ms/vscode-remote/devcontainer.json or the definition README at
+{
+ "name": "HACS Documentation",
+ "image": "node:lts",
+ "context": "..",
+ "settings": { 
+ "terminal.integrated.shell.linux": "/bin/bash"
+ },
+ "appPort": ["3000:3000"],
+ "postCreateCommand": "npm install",
+ "extensions": [
+ "dbaeumer.vscode-eslint"
+ ]
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.docusaurus
+build

README.md

@@ -0,0 +1,7 @@
+# HACS Documentation
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/ec224ba7-b3fb-4fc6-929e-991ba9801b53/deploy-status)](https://app.netlify.com/sites/hacs/deploys)
+
+This repository hosts the documentation that you can see on https://hacs.xyz
+
+[For more details on how to contribute have a look here.](https://hacs.xyz/docs/developer/documentation)

documentation/basic/data.md

@@ -0,0 +1,6 @@
+---
+id: data
+title: Data
+---
+
+All data it handles are saved to `hacs.*` files that is located under `.storage`

documentation/basic/events.md

@@ -0,0 +1,32 @@
+---
+id: events
+title: Events
+---
+
+When HACS operate it will fire some events that the frontend listens to.
+
+These events can also be used in automations.
+
+### Events
+
+- `hacs/update`
+- `hacs/repository`
+
+
+### Automation example
+
+This will create a new `persistent_notification` every time a new repository is added to HACS.
+
+```yaml
+automation:
+ trigger:
+ platform: event
+ event_type: hacs/repository
+ event_data:
+ action: registration
+ action:
+ service: persistent_notification.create
+ data_template:
+ title: New repository in HACS
+ message: "{{ trigger.event.data.repository }} was just added to HACS."
+```

documentation/basic/existing_elements.md

@@ -0,0 +1,10 @@
+---
+id: existing_elements
+title: Existing elements
+---
+
+This will not scan you local file system for existing elements.
+
+Why?
+
+Trust. If this did not download it, there'd be no way to know which version you have, so for elements you already have you will still need to click the "INSTALL" button for that element.

documentation/basic/getting_started.md

@@ -0,0 +1,24 @@
+---
+id: getting_started
+title: Getting started
+---
+
+![hacsdemo](/img/hacsdemo.gif)
+
+***
+
+## What can HACS do?
+
+This is a manager for your custom Home Assistant needs.
+
+It can help you download and update elements.
+
+It can also help you discover new awesome stuff.
+
+### What can it track/discover?
+
+- Custom integrations (components/platforms/custom_component) for Home Assistant
+- Custom plugins (cards/rows/mods) for Lovelace
+- AppDaemon apps for [AppDaemon](https://appdaemon.readthedocs.io/en/latest/)
+- Themes for the [frontend integration](https://www.home-assistant.io/components/frontend/) in Home Assistant
+- "python_scripts" for the [`python_scripts` integration](https://www.home-assistant.io/components/python_script/) in Home Assistant

documentation/basic/logs.md

@@ -0,0 +1,17 @@
+---
+id: logs
+title: Logs
+---
+
+Like any other integration this logs to the `home-assistant.log` file.
+
+You can also click the "OPEN LOG" from the "SETTINGS" tab to show logs only related to this integration (useful when creating a issue)
+
+To enable `debug` logging, add this to your `configuration.yaml`:
+
+```yaml
+logger:
+ default: info
+ logs:
+ hacs: debug
+```

documentation/basic/navigation.md

@@ -0,0 +1,6 @@
+---
+id: navigation
+title: Navigation
+---
+
+Navigation

documentation/basic/sensor.md

@@ -0,0 +1,11 @@
+---
+id: sensor
+title: Sensor
+---
+
+During the setup HACS will add a new sensor to your installation (`sensor.hacs`).
+This will have the number of pending updates as the state.
+
+As attributes ther is a list of objects that you can use for display and/or automations.
+
+![sensor](https://user-images.githubusercontent.com/15093472/59136215-5ff29d00-8982-11e9-860f-75d382a4d3b7.png)

documentation/basic/startup.md

@@ -0,0 +1,11 @@
+---
+id: startup
+title: Startup
+---
+
+During the startup it will scan for know repositories, and there will be a progressbar indicating that it's working.
+
+![startup](/img/bg_task.PNG)
+
+This is completely normal, and you can still use it while it's working.
+The same indication will show when a scheduled task is running.

documentation/basic/theming.md

@@ -0,0 +1,18 @@
+---
+id: theming
+title: Theming
+---
+
+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:
+
+| Variable | Usage |
+| ------------- | ------------- |
+| `hacs-badge-color` | Controls the background color on the "NEW" badges in the store, and the custom repository type badges in settings |
+| `hacs-badge-text-color` | Controls the text color on the "NEW" badges in the store, and the custom repository type badges in settings |
+| `hacs-status-installed` | Controls the icon color for installed, up-to-date components |
+| `hacs-status-pending-restart` | Controls the icon color for installed components that are awaiting a Home Assistant restart |
+| `hacs-status-pending-update` | Controls the icon color for installed components that have an update available |
+
+Here's a basic example of customizing one of these variables in `themes.yaml`:
+
+`hacs-badge-text-color: "var(--text-primary-color)"`

documentation/basic/updates.md

@@ -0,0 +1,26 @@
+---
+id: updates
+title: Updates
+---
+
+## Installed elements
+
+HACS will check for updates to installed elements:
+
+- At startup.
+- Every 30 minutes after HA startup.
+
+## Everything else
+
+HACS will check for updates to every element:
+
+- At startup
+- Every 800 minutes after HA startup.
+
+## Manually trigger updates
+
+You can also force a check by clicking the "RELOAD DATA" button under the "SETTINGS" tab _(This will force a reload of everything.)_
+
+Under the "SETTINGS" tab there is also a reload icon to the left of every custom repository you have added, clicking that will reload info for it.
+
+On each RepositoryView (the page with details about the element) there is a reload icon at the top-right corner, clicking that will reload it.

documentation/categories/appdaemon_apps.md

@@ -0,0 +1,10 @@
+---
+id: appdaemon_apps
+title: AppDaemon Apps
+---
+
+This page should contain:
+
+- What AppDaemon Apps are.
+- How you enable tracking in HACS.
+- Where downloaded files are stored.

documentation/categories/integrations.md

@@ -0,0 +1,6 @@
+---
+id: integrations
+title: Integrations
+---
+
+After installing a custom integration via HACS it is stored in your `config/custom_components` directory, each integration in a seperate directory.

documentation/categories/plugins.md

@@ -0,0 +1,7 @@
+---
+id: plugins
+title: Lovelace Plugins
+---
+
+The [Lovelace UI](https://www.home-assistant.io/lovelace/) is a customizable interface. With additional community plugins and cards you can extend the default Lovelace experience. 
+After downloading these cards, they are stored in seperate folders in your `config/www/community/`directory.

documentation/categories/python_scripts.md

@@ -0,0 +1,10 @@
+---
+id: python_scripts
+title: Python Scripts
+---
+
+This page should contain:
+
+- What Python Scripts are.
+- How you enable tracking in HACS.
+- Where downloaded files are stored.

documentation/categories/themes.md

@@ -0,0 +1,10 @@
+---
+id: themes
+title: Themes
+---
+
+This page should contain:
+
+- What Themes are.
+- How you enable tracking in HACS.
+- Where downloaded files are stored.

documentation/configuration/basic.md

@@ -0,0 +1,35 @@
+---
+id: basic
+title: Initial Configuration
+---
+
+_This page assume that you have allready finished the [installation](/docs/installation/prerequisites)_
+
+## In your Home Assistant UI go to "Configuration", then click "Integrations".
+
+![image](/img/conf1.png)
+
+## Click the "+" button in the bottom right corner
+
+![image](/img/conf2.png)
+
+## Search for or scroll down to find "HACS (Home Assistant Community Store)" and select it.
+
+![image](/img/conf3.png)
+
+## Add your configuration
+
+![image](/img/conf4.png)
+
+- `GitHub Personal Access Token`: The token you got when you finished [_this guide_](/docs/configuration/pat)
+- `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)
+
+## Click submit and wait for confirmation.
+
+![image](/img/conf5.png)
+
+_If something failed, you will be taken back to the [Add your configuration step](#add-your-configuration)_

documentation/configuration/legacy.md

@@ -0,0 +1,39 @@
+---
+id: legacy
+title: Configure HACS with YAML
+sidebar_label: YAML (legacy)
+---
+
+_This page assume that you have allready finished the [installation](/docs/installation/prerequisites)_
+
+## Example configuration
+
+```yaml
+hacs:
+ token: d73jds8f73jkr9d8sufv2br8sd9fy92nr9f80u23r97fhse (Don't copy+paste this token, create your own)
+```
+
+key | optional | default | description
+-- | -- | -- | --
+`token` | False | | [A Github Personal Access Token](/docs/configuration/pat)
+`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.
+`options` | True | | A map of options.
+
+### Options (map)
+
+```yaml
+hacs:
+ ...
+ options:
+ ...
+```
+
+option | description
+-- | --
+`country` | Set a filter based on your [A2(ISO) country code](https://www.worldatlas.com/aatlas/ctycodes.htm).
+`release_limit` | Number of releases to show in the version selector. (Defaults to 5)
+`experimental` | Boolean to enable experimental features (defaults to False).

documentation/configuration/options.md

@@ -0,0 +1,34 @@
+---
+id: options
+title: Configuration options
+---
+
+_This page assumes that you have already finished the [initial configuration](/docs/configuration/basic)_
+
+**This does _not_ apply if you configured HACS with YAML(legacy)**
+
+## In your Home Assistant UI go to "Configuration", then click "Integrations".
+
+![image](/img/conf1.png)
+
+## Select "HACS (Home Assistant Community Store)"
+
+![image](/img/option1.png)
+
+## Click the cogwheel icon in the top right corner
+
+![image](/img/option2.png)
+
+## Options
+
+![image](/img/option3.png)
+
+- `Filter with country code`: Only show repositories for your country (if the repository has information about that)
+- `Number of releases to show`: Number of releases to show in the dropdown.
+- `Enable experimental features`: This enables experimental features in HACS.
+
+## Click submit and wait for confirmation.
+
+_This will reload HACS and your changes will be reflected when you see the confirmation._
+
+![image](/img/option4.png)