docs: use flowing verse on debug page explaining DNS server failures#45141
Conversation
This is necessary because the project standard for documentation is flowing verse.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR reformats the DNS server troubleshooting page under the unsupported-installation docs to use the repository’s flowing-text style. It keeps the page’s purpose and technical guidance the same, while aligning the prose with the broader Home Assistant documentation format.
Changes:
- Reflows the introductory and solution paragraphs into flowing text.
- Keeps the existing CLI commands and troubleshooting steps intact.
- Applies the same formatting approach to the IPv6/DNS behavior explanation.
| Home Assistant requires a working DNS server to function. Without one it may be | ||
| unable to provide functionality like checking and executing updates, showing | ||
| documentation, reach external services required by add-ons and integrations, etc. | ||
| Home Assistant requires a working DNS server to function. Without one it may be unable to provide functionality like checking and executing updates, showing documentation, reach external services required by add-ons and integrations, etc. |
There was a problem hiding this comment.
@Copilot Did this issue arise as a result of this PR? If not, I will most likely open another PR for this change.
| Home Assistant requires a working DNS server to function. Without one it may be | ||
| unable to provide functionality like checking and executing updates, showing | ||
| documentation, reach external services required by add-ons and integrations, etc. | ||
| Home Assistant requires a working DNS server to function. Without one it may be unable to provide functionality like checking and executing updates, showing documentation, reach external services required by add-ons and integrations, etc. |
There was a problem hiding this comment.
@Copilot Don't you think that that would belong in a different PR?
|
|
||
| If you see this that means the application you are using for DNS is not handling | ||
| A and AAAA requests correctly. You can test this by executing the following commands: | ||
| If you see this that means the application you are using for DNS is not handling A and AAAA requests correctly. You can test this by executing the following commands: |
There was a problem hiding this comment.
@Copilot Do you think that that would belong in a different PR?
| this situation, particularly around updates and installing software. | ||
| A DNS server handling A and AAAA requests correctly will respond with status `NOERROR` for both of those queries even though there are no answers for the AAAA request. A DNS server mishandling this request will only return a `NOERROR` response for the first one and will return `NXDOMAIN`, `REFUSED`, `SERVFAIL` or some other error status for the second. | ||
|
|
||
| It is important to use a DNS server that handles this situation correctly since Home Assistant uses alpine for many of its containers. Alpine follows the DNS spec and will treat the entire domain as if it can't be resolved if it receives an error status for either query. Home Assistant will run into many unexpected issues in this situation, particularly around updates and installing software. |
There was a problem hiding this comment.
@Copilot That will most likely be in another PR.
Co-authored-by: Simon Lamon <32477463+silamon@users.noreply.github.com>
Proposed change
Refactor the documentation page explaining DNS server failures to use flowing verse
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.