jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reporting issues: add to TOC, add related links (#33317)

Browse Source
This commit is contained in:
c0ffeeca7 2024-06-18 15:41:19 +02:00 committed by GitHub
parent a3731c5be1
commit 9e7ea29ad6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
source/_includes/asides/help_navigation.html
View File

@ -9,6 +9,9 @@
<i class="icon-external-link"></i>
</a>
</li>
<li>
{% active_link /help/reporting_issues/ Reporting issues %}
</li>
<li>
Governance
<ul>

15
source/help/reporting_issues.markdown
View File

@ -2,6 +2,15 @@
title: "Reporting issues"
description: "Reporting issues about Home Assistant"
sidebar: false
related:
- docs: /docs/configuration/
title: Configuration.yaml file
- docs: /docs/configuration/troubleshooting/
title: Enable debug logging
- url: https://community.home-assistant.io/
title: Forum
- docs: /help/
title: Bug trackers
---
If you have an installation, a setup or a configuration issue, please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can.
@ -43,7 +52,7 @@ The information contained in the generated diagnostics file is redacted to avoid
### Problem-relevant `configuration.yaml` entries
To exclude configuration issues and allow the developers to quickly test, and perhaps reproduce, your issue, add the relevant part of your `configuration.yaml` file. This file is located in your [configuration folder](/docs/configuration/).
To exclude configuration issues and allow the developers to quickly test, and perhaps reproduce, your issue, add the relevant part of your {% term "`configuration.yaml`" %} file. This file is located in your [configuration folder](/docs/configuration/).
```yaml
sensor:
@ -54,7 +63,7 @@ Make sure that you don't post your username, password, API key, access token or
### Traceback and log information (if applicable)
If things go wrong, there will be a so-called traceback or an error message {% my logs title="in your log" %}. Please include this. It starts with **Traceback** and can contain information about where the error was triggered in the code.
If things go wrong, there will be a so-called traceback or an error message in your logs under {% my logs title="**Settings** > **System** > **Logs**" %}. Please include this. It starts with **Traceback** and can contain information about where the error was triggered in the code.
```bash
Traceback (most recent call last):
@ -65,6 +74,8 @@ In some cases, it is also necessary to [enable debug logging](/docs/configuratio
Enabling this will instruct Home Assistant to log a lot of fine-grained information about the integration. This is helpful for debugging and fixing the issue.
In contrast to the diagnostics information, debug logs are not automatically redacted. Make sure to include only the parts you think are relevant to the issue.
Look at the `home-assistant.log` file in the [configuration folder](/docs/configuration/) and see if there are any errors related to your integration.
### Additional information
This section can contain additional details or other observation. Often the little things can help as well.