diff --git a/source/docs/use/repositories/dashboard.md b/source/docs/use/repositories/dashboard.md index a8cc5643..81cd607b 100644 --- a/source/docs/use/repositories/dashboard.md +++ b/source/docs/use/repositories/dashboard.md @@ -8,14 +8,14 @@ This section shows you how to use the HACS dashboard. ## Browsing repositories 1. To open HACS, in the Home Assistant sidebar, select the HACS icon. - - Each line in the data table represents a community repository that can be downloaded via HACS. + - Each line in the data table represents a community repository that can be downloaded via HACS. ![nav_overview](/assets/images/screenshots/overview/base/light.png#only-light) ![nav_overview](/assets/images/screenshots/overview/base/dark.png#only-dark) 2. To browse the repositories, use the [search](#search-repositories) and [filter](#filter-repositories) functions. - - The HACS dashboard uses the same [table features](https://www.home-assistant.io/docs/organizing/filtering) used elsewhere in Home Assistant. - - By default, the dashboard shows the repositories you have downloaded with HACS on top of the list. + - The HACS dashboard uses the same [table features](https://www.home-assistant.io/docs/organizing/filtering) used elsewhere in Home Assistant. + - By default, the dashboard shows the repositories you have downloaded with HACS on top of the list. 3. To view the repository documentation, the select the 3 dots :material-dots-vertical: menu, then select **Show details**. - - To view the source code, select **Repository**. + - To view the source code, select **Repository**. 4. Once you found the custom element you want to use in Home Assistant, [download the repository](#downloading-a-repository). ## {{coreui("ui.components.data-table.search")}} repositories @@ -43,20 +43,24 @@ You can search for both downloaded and available repositories in HACS. ![nav_overview](/assets/images/screenshots/overview/filter/dark.png#only-dark) 2. There are currently 2 filter types: - - **Status**: For example, show only repositories that have been **Downloaded** or are **New**. - - **Type**: filters for a specific [type](/docs/use/repositories/type/index.md) of custom element, such as integration, dashboard, or theme. + - **Status**: For example, show only repositories that have been **Downloaded** or are **New**. + - **Type**: filters for a specific [type](/docs/use/repositories/type/index.md) of custom element, such as integration, dashboard, or theme. 3. **Troubleshooting**: Don't see the status or type in your table? - - Make sure the [columns are not hidden](https://www.home-assistant.io/docs/organizing/tables#customizing-columns) + - Make sure the [columns are not hidden](https://www.home-assistant.io/docs/organizing/tables#customizing-columns) -## Update repository metadata +## Updating repository metadata HACS regularly checks the repositories for updates and imports the new meta data, if there were changes. The meta data is what HACS knows about this repository. For example: the description, the documentation, the version information. In general, you do not need to check for updates. It is done automatically. But if you want to check immediately, you can manually trigger an update of the repository data. 1. In Home Assistant, open HACS and find the repository of interest. 2. On the repository entry, select the 3 dots :material-dots-vertical: menu, then select **Update information**. - - **Result**: If there were changes, the repository meta data is updated. - - You can now make an informed decision whether you want to [download](#downloading-a-repository) the new version of the repository (if there even was a new version). + - **Result**: If there were changes, the repository meta data is updated. + - You can now make an informed decision whether you want to [download](#downloading-a-repository) the new software version of the repository (if there even was a new version). + + !!! note "Update information does not change the downloaded repository content" + + **Update information** only updates what HACS knows about this repository. To get the new software version, you need to [download](#downloading-a-repository) it. ## Downloading a repository @@ -64,26 +68,26 @@ To use the functionality provided by a repository, you need to download it to Ho 1. In Home Assistant, open HACS and find the repository of interest. 2. Select the repository and view it's overview page. - - The main section of this view renders the README file of the repository. - - The **badges** on top provide some key information, such as author, [GitHub](https://github.com) stars, and number of open issues and pull requests. - - This page should also contain the documentation on how to use it. - - The content depends on the repository [type](/docs/use/repositories/type/index.md) and on the information the author provides. + - The main section of this view renders the README file of the repository. + - The **badges** on top provide some key information, such as author, [GitHub](https://github.com) stars, and number of open issues and pull requests. + - This page should also contain the documentation on how to use it. + - The content depends on the repository [type](/docs/use/repositories/type/index.md) and on the information the author provides. ![Repository dashboard](/assets/images/screenshots/repository/overview/light.png#only-light) ![Repository dashboard](/assets/images/screenshots/repository/overview/dark.png#only-dark) 3. To download the repository, in the bottom-right corner, select the **Download** button. - - This opens a dialog that lets you select a specific version. - - Typically, you would install the latest version. - - A reason to choose an older version of a repository would be, if you run an older version of Home Assistant and the newer version of the repository requires a newer version of Home Assistant. - - Check the documentation of the repository to find out which version of Home Assistant is required. - - Don't see a download button? The button doesn't show if the repository has already been downloaded. + - This opens a dialog that lets you select a specific version. + - Typically, you would install the latest version. + - A reason to choose an older version of a repository would be, if you run an older version of Home Assistant and the newer version of the repository requires a newer version of Home Assistant. + - Check the documentation of the repository to find out which version of Home Assistant is required. + - Don't see a download button? The button doesn't show if the repository has already been downloaded. ## Removing a repository 1. In Home Assistant, open HACS and find the repository you want to remove. 2. On the repository entry, select the 3 dots :material-dots-vertical: menu, then select **Remove**. - - This removes the repository that was stored in your [Home Assistant configuration directory](https://www.home-assistant.io/docs/configuration/#to-find-the-configuration-directory). + - This removes the repository that was stored in your [Home Assistant configuration directory](https://www.home-assistant.io/docs/configuration/#to-find-the-configuration-directory). 3. Removing the repository does not remove the related data. Check the documentation of the repository for instructions on how to remove it. ## Reporting an issue with a repository @@ -91,7 +95,7 @@ To use the functionality provided by a repository, you need to download it to Ho If you're experiencing an issue with a particular custom element, always report the issue to the repository owner, not to HACS or Home Assistant. 1. On the repository entry, select the 3 dots :material-dots-vertical: menu, then select **Open issue**. - - This opens the issue tracker of the GitHub repository for that custom element. + - This opens the issue tracker of the GitHub repository for that custom element. 2. To open an issue, in their repository, select **New issue**. 3. Add a detailed description of your issue and submit.