docs: Adjust Settings Value Examples#774
Draft
irishgordo wants to merge 1 commit intoharvester:mainfrom
Draft
Conversation
* adjust settings value examples, in YAML wrapping {} JSON blobs will
need to be done with something like single-quotes '', and have other
content escaped where applicable
Resolves: docs/adj-settings
See also: harvester/harvester#7456
Signed-off-by: Mike Russell <michael.russell@suse.com>
|
Collaborator
|
Hi @irishgordo FYI, I just rebased this PR for testing preview. |
Contributor
Author
|
@Yu-Jack - I'm wondering if this PR makes sense or if it should be closed out 🤔 ? As I suppose it just depends on whether or not the end-user understands that anytime there is a value in the Harvester YAML configuration that is to be interpreted as JSON, that they need to escape that JSON for nested elements & also have Not sure if updating all the examples is the way to go or if maybe just adding a note? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Resolves: docs/adj-settings
See also: harvester/harvester#7456
Problem:
JSON values need to be wrapped and escaped
Solution:
Updating examples
Related Issue(s):
harvester/harvester#7456
Test plan:
N/A
Additional documentation or context
harvester/harvester#7456