Improve explanation of configuration validation #14000
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bramkragten
previously approved these changes
Oct 5, 2022
bramkragten
reviewed
Oct 5, 2022
src/translations/en.json
Outdated
| "heading": "Configuration validation", | ||
| "introduction": "Validate your configuration if you recently made some changes to it and want to make sure that it is all valid.", | ||
| "heading": "Restart", | ||
| "introduction": "A basic validation of the configuration is automatically done before restarting. The basic validation ensures the YAML configuration doesn't have errors which will prevent Home Assistant or any integration from starting. It's also possible to only do the basic validation check without restarting.", | ||
| "check_config": "Check configuration", | ||
| "valid": "Configuration valid!", |
There was a problem hiding this comment.
Should we change this to Configuration will not prevent Home Assistant from starting! 😝
There was a problem hiding this comment.
I gotta say I don't like this change. It's very wordy and I think people might think something is wrong instead of it saying valid/ok/good etc.
IMO the failure case should be the longer one and explain where a person should go to fix the problem.
bramkragten
approved these changes
Oct 5, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Improve explanation of configuration validation:
Type of change
Example configuration
Additional information
Checklist
If user exposed functionality or configuration variables are added/changed: