Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus authored Sep 30, 2023
2 parents 55b100a + 51bac35 commit 56a9ec3
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 16 deletions.
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,8 @@ updates:
schedule:
interval: daily
open-pull-requests-limit: 10
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
open-pull-requests-limit: 10
2 changes: 1 addition & 1 deletion .github/workflows/actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: 📦 Checkout the repository
uses: actions/checkout@v2
uses: actions/checkout@v4.1.0

- name: ✅ Run pre-commit
uses: pre-commit/action@v2.0.0
4 changes: 2 additions & 2 deletions documentation/basic/updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ description: "Data updates"
HACS will check for updates to downloaded elements:

- At startup.
- Every 2 hours after HA startup.
- Every 48 hours after HA startup.

## Everything else

HACS will check for updates to every element:

- At startup
- Every 25 hours after HA startup.
- Every 96 hours after HA startup.

## Manually trigger updates

Expand Down
2 changes: 1 addition & 1 deletion documentation/configuration/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You actually need to do this, don't skip it.

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

None of the items are optional, you need to accept everything before you can setup HACS.
Only the last item (experimental features) are optional, you need to accept everything above that before you can setup HACS.

## Device registration

Expand Down
20 changes: 12 additions & 8 deletions documentation/configuration/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ description: "Configuration options"
---

:::info
_This page assumes that you have already finished the [initial configuration](/docs/configuration/basic)_
_Finish [initial configuration](/docs/configuration/basic) before you modify HACS options described here._
:::

## In your Home Assistant UI go to the Integrations panel
## In Home Assistant, go to the Settings ➤ Integrations panel

[![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/)

Expand All @@ -20,14 +20,18 @@ _This page assumes that you have already finished the [initial configuration](/d

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

- `Side panel title`: The name/title you want to display for HACS in the sidebar.
- `Side panel title`: The text (name or title) to display for HACS in the sidebar. Defaults to "HACS".
- `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)
- NetDaemin apps is deprecated and will [deprecated](/docs/categories/netdaemon_apps#deprecation-notice) and will be removed from HACS.
- `Enable experimental features`: This enables experimental features in HACS.
- `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).
- NetDaemon apps is deprecated and will [deprecated](/docs/categories/netdaemon_apps#deprecation-notice) and will be removed from HACS.
- `Enable experimental features`: This enables [experimental features](https://experimental.hacs.xyz/) in HACS.

:::note
After you change the setting for experimental features, you must fully reload HACS. Restart Home Assistant and then, once Home Assistant has fully started, clear your browser cache.
:::

## Click submit and wait for confirmation

Expand Down
2 changes: 1 addition & 1 deletion documentation/faq/ha_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Updating Home Assistant broke HACS
---
If you are running an old version of HACS and update HA to a new version, HACS can partially or fully break.

To solve that, run the same command as you did to download HACS the first time, this will update HACS to it's current version.
To solve that, run the same command as you did to download HACS the first time, this will update HACS to its current version.
2 changes: 1 addition & 1 deletion documentation/publish/include.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Custom integrations that override core integrations will not be accepted, you ca

Add both these actions to your own repository and make sure they pass:

- https://github.com/home-assistant/actions#hassfest
- https://github.com/home-assistant/actions#hassfest (only for integrations)
- https://github.com/hacs/action

When all of this is covered, you can add it to repository category files in https://github.com/hacs/default
Expand Down
6 changes: 6 additions & 0 deletions documentation/publish/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ Key | Type | Required | Description
`hacs` | string | No | The minimum required HACS version.
`persistent_directory` | string | No | A relative path (within the integration directory) that will be kept safe during upgrades. *Can only be used with integrations.*

:::tip

The [`AwesomeVersion` demo](https://ludeeus.github.io/awesomeversion) can validate and check version compares.
That is the same library that HACS and Home Assistant use when checking versions.

:::

**examples:**

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

## Requirements

- You are running [Home Assistant](https://www.home-assistant.io/) version [`2022.11.0`](https://my.home-assistant.io/redirect/info) or newer.
- You are running [Home Assistant](https://www.home-assistant.io/) version [`2023.6.0`](https://my.home-assistant.io/redirect/info) or newer.
- You are running a [supported](https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md) Home Assistant installation.
- You have the [`my` integration](https://www.home-assistant.io/integrations/my/) enabled.
- You have Access to the filesystem where the Home Assistant configuration files are located.
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ module.exports = {
prism: {
darkTheme: require('prism-react-renderer/themes/dracula'),
},
image: 'https://assets.hacs.xyz/logo.svg',
image: 'https://assets.hacs.xyz/banner.png',
description: 'HACS gives you a powerful UI to handle downloads of all your custom needs.',
navbar: {
title: 'HACS',
Expand Down
Binary file modified static/img/part1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 56a9ec3

Please sign in to comment.