Skip to content

Commit

Permalink
Install -> download (hacs#212)
Browse files Browse the repository at this point in the history
* Install -> download

* fix links

* add .node-version

* fix link

* more links

* more
  • Loading branch information
ludeeus committed Sep 4, 2021
1 parent 3f8c9e4 commit 9d16d70
Show file tree
Hide file tree
Showing 37 changed files with 82 additions and 158 deletions.
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
14
62 changes: 0 additions & 62 deletions documentation/basic/automation.md

This file was deleted.

17 changes: 0 additions & 17 deletions documentation/basic/events.md

This file was deleted.

2 changes: 1 addition & 1 deletion documentation/basic/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: "Getting started"

## What can HACS do?

HACS is a manager for installing and maintaining custom elements for Home Assistant.
HACS is a manager for downloading and maintaining custom elements for Home Assistant.

It can help you download and update elements, and can also help you discover new and awesome stuff!

Expand Down
2 changes: 0 additions & 2 deletions documentation/basic/sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@ The state of `sensor.hacs` is the number of pending updates.

The HACS sensor also has several attributes that can be used for display and/or automation.

[Have a look here for automation examples](basic/automation.md)

![sensor](https://user-images.githubusercontent.com/15093472/59136215-5ff29d00-8982-11e9-860f-75d382a4d3b7.png)
6 changes: 3 additions & 3 deletions documentation/basic/updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ description: "Data updates"
HACS will check for updates to installed elements:

- At startup.
- Every 30 minutes after HA startup.
- Every 2 hours after HA startup.

## Everything else

HACS will check for updates to every element:

- At startup
- Every 800 minutes after HA startup.
- Every 25 hours after HA startup.

## Manually trigger updates

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.
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.
6 changes: 3 additions & 3 deletions documentation/categories/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ Integrations in HACS (or custom_components as they are often referred to) are co
## Special notes about Integrations

:::info
When you install, update or uninstall an integration in HACS, you need to restart Home Assistant.
When you download, update or remove an integration in HACS, you need to restart Home Assistant.
:::

:::info
There is 1 exception to this:
If the integration supports configuration with `config_flow`, you do not have to restart Home Assistant after the installation.
If the integration supports configuration with `config_flow`, you do not have to restart Home Assistant after the download.
You can go straight to the "Configuration" section of the UI, then to "Integrations".
:::

:::tip
You _may_ need to clear your browser cache before you see it in the "+" list.

_Note that this **only** applies for the installation and initial configuration of that Integration, if you update it, you still need to restart Home Assistant before it loads the new files._
_Note that this **only** applies for the initial download of that Integration, if you update it, you still need to restart Home Assistant before it loads the new files._
:::

## Integrations download location
Expand Down
4 changes: 2 additions & 2 deletions documentation/categories/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ Your plugin exists in `www/community/plugin/plugin.js` you can use both `/local/
### Open source

:::tip
Every plugin you have installed with HACS will have an "Open source" option on the hamburger menu.
This is useful when troubleshooting; if you can see a code wall (the underlying `.js` file) everything is OK, but if you get a 404 try reinstalling it.
Every plugin you have downloaded with HACS will have an "Open source" option on the hamburger menu.
This is useful when troubleshooting; if you can see a code wall (the underlying `.js` file) everything is OK, but if you get a 404 try downloading it again.
:::
2 changes: 1 addition & 1 deletion documentation/community_guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Community guides
description: "Guides, Tutorials & Videos about HACS"
---

_Here you can find community made guides, tutorials & videos about how to install/use HACS._
_Here you can find community made guides, tutorials & videos about how to setup/use HACS._

:::warning
**NB!: Most of what you find here is static, and may not be up to date.**
Expand Down
2 changes: 1 addition & 1 deletion documentation/configuration/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Basic configuration"
---

:::info
_This page assume that you have already completed the [installation](/docs/installation/prerequisites)_
_This page assume that you have already completed the [download](/docs/setup/prerequisites)_
:::

## In your Home Assistant UI go to "Configuration", then click "Integrations"
Expand Down
2 changes: 1 addition & 1 deletion documentation/configuration/legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Configure HACS with YAML (legacy)"
---

:::info
_This page assume that you have already finished the [installation](/docs/installation/prerequisites)_
_This page assume that you have already finished the [download](/docs/setup/prerequisites)_
:::

## Example configuration
Expand Down
2 changes: 1 addition & 1 deletion documentation/configuration/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Configuration"
---

:::info
_This page assumes you have already completed the [installation](/docs/installation/prerequisites)_
_This page assumes you have already completed the [download](/docs/setup/prerequisites)_
:::


Expand Down
8 changes: 4 additions & 4 deletions documentation/developer/maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ HACS is prepared to handle those, and this is the flow of it:
3. When it's merged, HACS will know about it during the next scan (30min or Home Assistant restart.)
3. HACS receives an updated [critical file](https://github.com/hacs/default/blob/master/critical).

### If the repository is installed with HACS
### If the repository is download with HACS

1. The repository is uninstalled.
1. The repository files is removed.
2. The repository is removed from HACS.
3. Home Assistant is restarted to make sure it's not loaded anymore.
4. When Home Assistant starts up, you will have a `critical` log entry, and a persistent notification telling you to open the HACS panel.
Expand All @@ -47,8 +47,8 @@ If you click the "More info about this incident" button you will be taken to the

If you click the "Acknowledge" button, you will not see that message anymore.

### If the repository is not installed with HACS
### If the repository is not download with HACS

1. The repository is removed from HACS.

_That's it, since it was not installed, no further action from HACS is necessary_
_That's it, since it was not download, no further action from HACS is necessary_
2 changes: 1 addition & 1 deletion documentation/faq/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Add-ons?
description: "NO, no, nope, this is not an add-on, and does not handle add-ons"
---

- You cannot install HACS as an add-on, HACS is an integration, and not an add-on
- You cannot download HACS as an add-on, HACS is an integration, and not an add-on
- HACS does not handle add-ons.

Add-ons and HACS has nothing to do with each other, they are completely different.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: installation
title: "How does it work: Installation"
description: "How does it work: Installation"
id: download
title: "How does it work: Download"
description: "How does it work: Download"
---
When you install an element this is what's happening:
When you download an element this is what's happening:

1. The local target directory(folder) is deleted.
1. A new local target directory is created.
Expand Down
2 changes: 1 addition & 1 deletion documentation/faq/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ description: "TLDR;"
In short:

- Help you discover new custom elements.
- Help you install (download) new custom elements.
- Help you download new custom elements.
- Help you keep track of your custom elements.
4 changes: 2 additions & 2 deletions documentation/faq/initial_startup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: "Initial startup"
---
HACS does not ship with any knowledge about the repositories it is supposed to show.

Since there is no central "HACS server", every installation of HACS fetches this information from GitHub, it has to get the information about all [default repositories](/default_repositories)
Since there is no central "HACS server", every installation that runsHACS fetches this information from GitHub, it has to get the information about all [default repositories](/default_repositories)

To get the information that is needed to show a representation of the repository in HACS, HACS uses the [GitHub API](https://docs.github.com/en/rest), this API is [rate limited](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) and when you hit that rate limit, HACS will pause any communication to the GitHub API until the rate limit reset (can take up to one hour).

:::info
For a new installation of HACS, with the current amount of default repositories you will hit that rate limit on the initial startup after installing HACS.
For a new setups with HACS, with the current amount of default repositories you will hit that rate limit on the initial startup after downloading HACS.
Because of this, HACS will be in a "Starting up" state until it's done fetching the information for all [default repositories](/default_repositories)

Which in return will cause the initial startup of HACS to take over 1 hour to finish.
Expand Down
3 changes: 2 additions & 1 deletion documentation/faq/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ 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.

- If you download/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.
2 changes: 1 addition & 1 deletion documentation/faq/status_not_loaded.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "What to do if the status of a Lovelace element is not loaded"

![not_loaded](/img/not_loaded_entry.png)

When you see this message you have one or more resources installed with HACS that are not properly loaded in Lovelace.
When you see this message you have one or more resources downloaded with HACS that are not properly loaded in Lovelace.

To find out what element it is, look for the repository with a "Not Loaded" header in the Frontend section of HACS.

Expand Down
3 changes: 2 additions & 1 deletion documentation/faq/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ id: upgrade
title: "How does it work: Upgrade"
description: "How does it work: Upgrade"
---
The same as installation.

The same as download.
2 changes: 1 addition & 1 deletion documentation/navigation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Every repository that has a pending update will show here, if you click on one o

## Sections

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

### Integrations

Expand Down
2 changes: 1 addition & 1 deletion documentation/navigation/stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Store tabs"

![nav_stores](/img/stores.png)

This is where you can browse your installed repositories.
This is where you can browse your downloaded repositories.

## Add new repositories

Expand Down
2 changes: 1 addition & 1 deletion documentation/publish/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The action have 3 run types:

The action itself lives [here](https://github.com/hacs/action) and you are free to inspect the code and/or make a PR to add changes.

To install it, follow these steps:
To use it, follow these steps:

1. Go to your repository on GitHub
1. Click on "Create new file"
Expand Down
4 changes: 2 additions & 2 deletions documentation/publish/appdaemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ README.md

#### If there are releases

When installing/upgrading it will scan the content in the latest release.
When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
If there are multiple releases in the repository the user have some options to download a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases
Expand Down
2 changes: 1 addition & 1 deletion documentation/publish/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ You must have added your integration to [home-assistant/brands](https://github.c

It is preferred but not required to publish releases in your repository.

*If you publish releases in your repository, HACS will present the user with a nice selection view of the 5 latest releases together with the default branch when they are installing or upgrading your integration.*
*If you publish releases in your repository, HACS will present the user with a nice selection view of the 5 latest releases together with the default branch when they are downloading or upgrading your integration.*

*If you don't publish releases in your repository, HACS will use the files in the branch marked as default.*

Expand Down
4 changes: 2 additions & 2 deletions documentation/publish/netdaemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ README.md

#### If there are releases

When installing/upgrading it will scan the content in the latest release.
When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
If there are multiple releases in the repository the user have some options to download a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases
Expand Down
4 changes: 2 additions & 2 deletions documentation/publish/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ If your plugin require files that are not `js` files, place all files (including

#### If there are releases

When installing/upgrading it will scan the content in the latest release.
When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
If there are multiple releases in the repository the user have some options to download a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases
Expand Down
4 changes: 2 additions & 2 deletions documentation/publish/python_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ README.md

#### If there are releases

When installing/upgrading it will scan the content in the latest release.
When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
If there are multiple releases in the repository the user have some options to download a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases
Expand Down
2 changes: 1 addition & 1 deletion documentation/publish/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ version_installed | The installed version

## Want to add your repository to the store as a default?

[See here for how to add a custom repository.](../include)
[See here for how to add a custom repository.](/docs/publish/include)

## Badges

Expand Down
4 changes: 2 additions & 2 deletions documentation/publish/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ README.md

#### If there are releases

When installing/upgrading it will scan the content in the latest release.
When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
If there are multiple releases in the repository the user have some options to download a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases
Expand Down
Loading

0 comments on commit 9d16d70

Please sign in to comment.