Skip to content

Commit

Permalink
Update docs (hacs#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed May 21, 2020
1 parent 1935453 commit 17f4d9c
Show file tree
Hide file tree
Showing 31 changed files with 84 additions and 280 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
.docusaurus
build/
build/
yarn-error.log
4 changes: 2 additions & 2 deletions documentation/basic/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: Data
description: "HACS Data stores"
---

All data it handles are saved to `hacs.*` files that is located under `.storage`
All data it handles are saved to files that is located under `.storage`

:::caution
Remeber to backup these files.
:::
:::
5 changes: 3 additions & 2 deletions documentation/basic/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Getting started"

![hacsdemo](/img/demo.gif)

***
---

## What can HACS do?

Expand All @@ -17,7 +17,8 @@ It can help you download and update elements, and can also help you discover new
### What can it track/discover?

- Custom integrations (components/platforms/custom_component) for Home Assistant
- Custom plugins (cards/rows/mods) for Lovelace
- Custom lovelace elements (cards/rows/mods)
- AppDaemon apps for [AppDaemon](https://appdaemon.readthedocs.io/en/latest/)
- NetDaemon apps for [NetDaemon](https://netdaemon.xyz/)
- 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
3 changes: 2 additions & 1 deletion documentation/basic/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ To enable `debug` logging, add this to your `configuration.yaml`:
logger:
default: info
logs:
custom_components.hacs: debug
hacs: debug
queueman: debug
AioGitHub: debug
AIOGitHubAPI: debug
```
12 changes: 0 additions & 12 deletions documentation/basic/startup.md

This file was deleted.

5 changes: 2 additions & 3 deletions documentation/categories/appdaemon_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _There are 2 ways of doing this._

Add a checkmark to the left of AppDaemon apps in the UI configuration for HACS.

![configuration](/img/conf4.png)
![configuration](/img/option3.png)

[For more about configuring HACS with the UI have a look here](configuration/basic.md)

Expand All @@ -36,9 +36,8 @@ After adding that you need to restart Home Assistant.

[For more about configuring HACS with YAML have a look here](configuration/legacy.md)


## AppDaemon apps download location

:::info
Any AppDaemon app downloaded with HACS is stored in `appdaemon/apps/` in your Home Assistant configuration directory.
:::
:::
8 changes: 4 additions & 4 deletions documentation/categories/netdaemon_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _There are 2 ways of doing this._

Add a checkmark to the left of NetDaemon apps in the UI configuration for HACS.

![configuration](/img/conf4.png)
![configuration](/img/option3.png)

[For more about configuring HACS with the UI have a look here](configuration/basic.md)

Expand All @@ -36,14 +36,14 @@ After adding that you need to restart Home Assistant.

[For more about configuring HACS with YAML have a look here](configuration/legacy.md)


## NetDaemon apps download location

:::info
Any NetDaemon app downloaded with HACS is stored in `netdaemon/apps/` in your Home Assistant configuration directory.
:::

***
---

:::caution
_NetDaemon app support was added in HACS version 0.23.0_
:::
:::
18 changes: 10 additions & 8 deletions documentation/configuration/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Basic configuration"
_This page assume that you have already completed the [installation](/docs/installation/prerequisites)_
:::

## In your Home Assistant UI go to "Configuration", then click "Integrations".
## In your Home Assistant UI go to "Configuration", then click "Integrations"

![image](/img/conf1.png)

Expand All @@ -20,20 +20,22 @@ Before HACS can show up in the list you need to clear your browser cache.

![image](/img/conf2.png)

## Search for or scroll down to find "HACS (Home Assistant Community Store)" and select it.
## Search for or scroll down to find "HACS (Home Assistant Community Store)" and select it

![image](/img/conf3.png)

:::info
You see this when Home Assistant is installing the requirements needed for the integration.
![image](/img/conf_note.png)

If this takes longer than 10 minutes, you may have and issue with your Home Assistant installation.
:::

## 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`: [DEPRECATED!] Enables [Python Scripts](/docs/categories/python_scripts)
- `Enable Themes discovery & tracking`: [DEPRECATED!] Enables [Themes](/docs/categories/themes)

## Click submit and wait for confirmation.

Expand All @@ -43,4 +45,4 @@ _If something failed, you will be taken back to the [Add your configuration step

## Changing the configuration

If you need to change the configuration, you first need to delete the integration from the integrations list, then you need to add it back again.
If you need to change the configuration, you first need to delete the integration from the integrations list, then you need to add it back again.
36 changes: 10 additions & 26 deletions documentation/configuration/legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,13 @@ 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.
`netdaemon` | True | `False` | Enable tracking of NetDaemon apps.
`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)

```yaml
hacs:
token: xxxxxxxxxxxxxxxxxxxxxxxxx
...
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).
| 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. |
| `netdaemon` | True | `False` | Enable tracking of NetDaemon apps. |
| `country` | True | | Set a filter based on your [A2(ISO) country code](https://www.worldatlas.com/aatlas/ctycodes.htm). |
| `release_limit` | True | `5` | Number of releases to show in the version selector. |
| `experimental` | True | `False` | Boolean to enable experimental features. |
14 changes: 7 additions & 7 deletions documentation/configuration/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@ _This page assumes that you have already finished the [initial configuration](/d

![image](/img/conf1.png)

## Select "HACS (Home Assistant Community Store)"
## Select "Options" on the card for "HACS"

![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)
- `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.
- `Number of releases to show`: Number of releases to show in the dropdown.
- `Filter with country code`: Only show repositories for your country (if the repository has information about that)
- `Enable AppDaemon apps discovery & tracking`: Enables [AppDaemon](/docs/categories/appdaemon_apps)
- `Enable NetDaemon apps discovery & tracking`: Enables [NetDaemon](/docs/categories/netdaemon_apps)
- `Enable experimental features`: This enables experimental features in HACS.

## Click submit and wait for confirmation.
## Click submit and wait for confirmation

_This will reload HACS and your changes will be reflected when you see the confirmation._

Expand Down
5 changes: 2 additions & 3 deletions documentation/installation/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ description: "Remove HACS"

If you want to remove HACS you need to do that using the folowing steps.


1. Remove the configuration from `configuration.yaml`(if configured with legacy(YAMl)) or remove it using the trashbin icon on the integration page.
1. Restart Home Assistant **important**
1. Restart Home Assistant (yes, this needs to be done twice) **important**
1. Delete the `hacs` directory under `custom_components`.
1. Delete all files containing `hacs` under the `.storage` directory.
1. Delete all files and directories containing `hacs` under the `.storage` directory.
1. Restart Home Assistant.

When removed the wrong way. An option is to install it again.
When removed the wrong way. An option is to install it again.
Just move hacs back to custom components and reboot. And start the remove procedure again.
22 changes: 0 additions & 22 deletions documentation/navigation/installed.md

This file was deleted.

21 changes: 0 additions & 21 deletions documentation/navigation/layout.md

This file was deleted.

59 changes: 14 additions & 45 deletions documentation/navigation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,61 +6,30 @@ description: "Overview of the HACS UI"

This is the overview of HACS.

![nav_overview](/img/nav_overview.png)
![nav_overview](/img/overview.png)

The overview consist of a header, [tabs](#tabs) and a [menu button (in the top right corner)](#menu-button)
The overview consist of the sections you have enabled, your pending updates and important messages.

## Tabs
## Pending updates

Every tab you see here serves a separate purpose:
Every repository that has a pending update will show here, if you click on one of them a popup will show that give you the option to update it.

- [Installed](/docs/navigation/installed) This is where you get an overview of your installed repositories.
- [Stores (Integrations, plugins, appdaemon apps, python scripts, themes)](/docs/navigation/stores) This is where you can browse and install new repositories
- [Settings](/docs/navigation/settings) Settings and advanced features for HACS.
## Sections

This is your gateway to the sections in HACS where you will find your installed repositories.

If you click on a repository under the installed or store tabs, you will get to the page of that [repository](/docs/navigation/repository).
### Integrations

Here are your integrations (custom_components)

## Menu button
### Frontend

![menubutton](/img/hacs_menu.png)
Here are your themes, and elements for lovelace.

The items in this list vary from what view you are viewing.
### Automation

- "Upgrade all" are only visible if you are on the "Installed" tab.
- "Table" and "Compact" are not visible on the "Settings" tab.
Here are your automations apps

### Menu items
### about

#### Documentation

This will open the documentation page for the tab you are viewing.

#### Reload data

This will start a background task that reloads the data of every repository HACS knows about.

#### Upgrade all

This will upgrade all installed repositories that have an update pending.

#### HACS Repo

This will take you to the HACS organisation page on GitHub.

#### Open issue

This will take you to where you can get information about creating issues under the HACS organisation.

#### Table

When active this changes the [layout](/docs/navigation/layout) to be in table mode.

#### Compact

When active this will comapct the [layout](/docs/navigation/layout) of HACS.

#### About

This shows a modal with info about HACS versions and the number of repositories it tracks.
This opens a popup with information about HACS.
Loading

0 comments on commit 17f4d9c

Please sign in to comment.