Skip to content

docs: Adjust Settings Value Examples #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

irishgordo
Copy link
Contributor

  • 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

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

* 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 <[email protected]>
@Yu-Jack Yu-Jack force-pushed the docs/adj-settings branch from c93c599 to bab807c Compare May 8, 2025 02:51
Copy link

github-actions bot commented May 8, 2025

Name Link
🔨 Latest commit bab807c
😎 Deploy Preview https://681c2147f751976b83f6a82b--harvester-preview.netlify.app

@Yu-Jack
Copy link
Collaborator

Yu-Jack commented May 8, 2025

Hi @irishgordo FYI, I just rebased this PR for testing preview.

@irishgordo
Copy link
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 '' single-quotes wrapped around it.

Not sure if updating all the examples is the way to go or if maybe just adding a note?
Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants