Add checks customization feature documentation #211
Conversation
This file contains hidden or 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
EMaksy
commented
Apr 8, 2025
|
|
||
| * Check description. | ||
|
|
||
| * Warning message that Trento & SUSE are not liable for system malfunctions due to custom check values. |
There was a problem hiding this comment.
This needs to be updated to trento-project/web@5b3fd48#diff-06abf413aa9c50485d856ed00a480751cd92119d6f6ce14458ce983fec6286ddR24-R26
|
|
||
| User input is validated to ensure that the input value matches the expected type before allowing to save the custom values in Wanda's database. If the input type is incorrect or mixed, the customization fails, triggering a toast notification, that checks customization failed and a warning message in the modal itself. | ||
|
|
||
| === Disable Check Customization |
There was a problem hiding this comment.
This part is very optional, and less user relevant. Feel free to skip it, as discussed
|
|
||
| By default, built-in checks are customizable, to disable customization for a specific check, the *customization_disabled: true* flag must be added to the corresponding check YAML file. This flag can be applied at the top level to disable customization entirely or at the value level to control which values remain customizable through the Web UI. | ||
|
|
||
| ==== Disable Check customization for all values: |
There was a problem hiding this comment.
This can be removed as mentioned in the comment before, but good for the understanding
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This Pr is a template for the upcoming checks customization feature for trento web.
The pr provides an adoc document which can be used in the main article.