Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove my badges #395

Merged
merged 1 commit into from
Oct 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions documentation/basic/diagnostics.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
---
id: diagnostics
title: Diagnostics
description: "How to get HACS diagnostics"
description: 'How to get HACS diagnostics'
---

Starting with Home Assistant 2022.2 integrations can now provide a diagnostics dump, HACS have this implemented.

The diagnostics dump is a JSON file with information about your instance, this is useful to upload to GitHub when creating issues.
To get the diagnostics dump for HACS do the following:

1. First to the integrations dashboard in the Home Assistant UI

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

2. Then click on the 3 dots in the bottom right corner of the card for HACS, and select "Download diagnostics"

![download diagnostics](/img/download_diagnostics.png)
1. First go to the "Settings" in the Home Assistant UI, then "Devices & Services" and the "Integrations" tab in the Home Assistant UI
1. Then click on the entry for HACS.
1. Then click on the 3 dots to the right of the card for HACS, and select "Download diagnostics"

![image showing how to download diagnostics](/img/diagnostics.png)

This will download a file with `json.txt` file ending to the computer you are doing this from (usually the downloads directory), this file can be pasted or dragged into GitHub issues.
13 changes: 3 additions & 10 deletions documentation/basic/my.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: my
title: "My Home Assistant"
description: "My link support"
title: 'My Home Assistant'
description: 'My link support'
---

:::note
Expand All @@ -19,12 +19,5 @@ This works for both default and custom repositories.

1. Start by going to https://my.home-assistant.io/create-link/?redirect=hacs_repository
1. Fill in the fields on that page to generate your My link.
1. "Category" is only needed for custom repositories
1. "Category" is only needed for custom repositories
1. Copy the URL or snippets you want for your My link.


Example for hacs/integration:

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=hacs&repository=integration)


27 changes: 14 additions & 13 deletions documentation/configuration/basic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: basic
title: Initial Configuration
description: "Basic configuration"
description: 'Basic configuration'
---

:::info
Expand All @@ -10,7 +10,8 @@ _This page assume that you have already completed the [download](/docs/setup/pre

## In your Home Assistant UI go to the 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/)
1. First go to the "Settings" in the Home Assistant UI
1. Then "Devices & Services" and the "Integrations" tab in the Home Assistant UI

## Clear your browser cache

Expand All @@ -20,11 +21,11 @@ Before HACS can show up in the list you need to clear your browser cache or perf
You actually need to do this, don't skip it.
:::

## Click the "+ ADD INTEGRATION" button in the bottom right corner
## Add the integration

[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=hacs)

## Search for or scroll down to find "HACS" and select it
1. Click on the "+ Add integration" button in the bottom right corner.
1. Search for "HACS".
1. Then select (click on) it.

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

Expand All @@ -38,45 +39,45 @@ Only the last item (experimental features) are optional, you need to accept ever

HACS uses a device OAuth flow for authentication against the GitHub API.

***
---

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

On the first screen you are presented with a device code, copy that to your clipboard and click on the [https://github.com/login/device](https://github.com/login/device) link to continue the setup.

**Do not click on submit yet!**

***
---

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

If you are not signed in to GitHub in your browser you need to signup or signin now to continue the setup, if you are already signed in, you can skip this part.

***
---

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

When that page is loaded up, paste or type in your device code that was presented to you in the previous step.

***
---

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

Here you click on "Authorize hacs".

***
---

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

Once you see the confirmation screen, you can close the tab and go back to Home Assistant.

***
---

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

Now you can click "Submit" to complete the configuration of HACS.

***
---

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

Expand Down
14 changes: 6 additions & 8 deletions documentation/configuration/options.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
---
id: options
title: Configuration options
description: "Configuration options"
description: 'Configuration options'
---

:::info
_Finish [initial configuration](/docs/configuration/basic) before you modify HACS options described here._
:::

## In Home Assistant, go to the Settings ➤ Integrations panel
## Change HACS options

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

## Select "Options" on the card for "HACS"

![image](/img/option1.png)
1. First go to the "Settings" in the Home Assistant UI, then "Devices & Services" and the "Integrations" tab in the Home Assistant UI
1. Then click on the entry for HACS.
1. On the card click on "Configure"

## Options

Expand All @@ -26,7 +24,7 @@ _Finish [initial configuration](/docs/configuration/basic) before you modify HAC
- `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.
- 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
Expand Down
10 changes: 3 additions & 7 deletions documentation/publish/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,8 @@ If the repository does not use tags, the 7 first characters of the last commit w

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

## My links (Badges)
## My links

Tell your users that your repository can be tracked with HACS by adding a [my-link](https://my.home-assistant.io) badge to your documentation.
Tell your users that your repository can be tracked with HACS by adding a [my-link](https://my.home-assistant.io) link to your documentation.

Generate a unique badge/link for your repository here: https://my.home-assistant.io/create-link/?redirect=hacs_repository

Example:

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=hacs&repository=integration&category=integration)
Generate a unique link for your repository here: https://my.home-assistant.io/create-link/?redirect=hacs_repository
7 changes: 2 additions & 5 deletions documentation/setup/download.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@ import TabItem from '@theme/TabItem';
You use the [HACS download script](https://github.com/hacs/get) to setup HACS.

:::info
If you are not sure what type of Home Assistant you are using, then you should probably not use HACS (or any other custom integration), but if you really want to know, you can find it here:

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

If you are not sure what type of Home Assistant you are using or how to find that, then you should probably not use HACS (or any other custom integration).
:::

<Tabs label="test">
<TabItem value="os" label="OS/Supervised" default>

1. Go to the [Add-on store](https://my.home-assistant.io/redirect/supervisor_store/)
1. Go to the Add-on store
1. Install one of the SSH add-ons (you need to enable advanced mode in your user profile to see them)
1. Configure the SSH add-on you chose by following the documentation for it
1. Start the SSH add-on
Expand Down
3 changes: 1 addition & 2 deletions documentation/setup/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ sidebar_position: 0

## Requirements

- 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 [Home Assistant](https://www.home-assistant.io/) version `2023.6.0` 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.
- You know how to access the Home Assistant log file.
- You are aware that there are **no** [add-ons](https://www.home-assistant.io/docs/glossary/#add-on) in HACS.
Expand Down
Binary file added static/img/diagnostics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/download_diagnostics.png
Binary file not shown.
Binary file removed static/img/option1.png
Binary file not shown.