Skip to content

Commit

Permalink
Add diagnostics documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Jan 30, 2022
1 parent 815db2a commit 9eb316b
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 0 deletions.
27 changes: 27 additions & 0 deletions documentation/basic/diagnostics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: diagnostics
title: Diagnostics
description: "How to get HACS diagnostics"
---

:::note

If you configured HACS with YAML, you do not have this option.

:::

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 installation, this is usefull to upload to GitHub when creating issues.
To get the diagnostics dump for HACS do the folowing:

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)]


This will download a JSON file to the computer you are doing this from (usually the downloads directory), this file can be uploaded to GitHub issues.
1 change: 1 addition & 0 deletions documentation/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Logs are **more** then _just_ errors, with debug logging it gives the person inv
- Debug logs.
- Steps to reproduce the issue.
- If the issue is in the UI, add screenshots.
- [Diagnostics](/docs/basic/diagnostics)

You can see examples of good/bad issues further down on this page.

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ module.exports = {
'basic/existing_elements',
'basic/sensor',
'basic/theming',
'basic/diagnostics',
'basic/logs',
],
Navigation: ['navigation/overview', 'navigation/stores'],
Expand Down
Binary file added static/img/download_diagnostics.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 9eb316b

Please sign in to comment.