Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add docs for multiline yaml var #26387

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add docs for multiline yaml var #26387

wants to merge 3 commits into from

Conversation

sgress454
Copy link
Contributor

@sgress454 sgress454 commented Feb 17, 2025 •
edited
Loading

For #26135

This PR adds a small section to the Yaml reference guide for GitOps explaining that environment variables are permitted, but multiline variables can be challenging. We reference environment variables elsewhere in the doc but IMO it's good to put this in the general doc section rather than just underneath docs for specific keys.

cc: @allenhouchins, as there was no specific bug to fix for #26135 but I think having this documented might have prevented the issues there.

@sgress454 sgress454 changed the title Sgress454/26135 docs for multiline yaml var Add docs for multiline yaml var Feb 17, 2025
@allenhouchins allenhouchins mentioned this pull request Feb 17, 2025
Open
noahtalerman
noahtalerman requested changes Feb 17, 2025
View reviewed changes
Copy link
Member

@noahtalerman noahtalerman left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless I'm misunderstanding, it looks like we decided to update the docs as a fix for this bug.

I think we want to make copy/pasting in the XML from Google Workspace work instead of updating the docs. More context here.

@sgress454
Copy link
Contributor Author

Unless I'm misunderstanding, it looks like we decided to update the docs as a fix for this bug.

I think we want to make copy/pasting in the XML from Google Workspace work instead of updating the docs. More context here.

replied in that thread

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@noahtalerman noahtalerman noahtalerman requested changes

@rachaelshaw rachaelshaw Awaiting requested review from rachaelshaw rachaelshaw is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

@rachaelshaw rachaelshaw

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sgress454 @noahtalerman @rachaelshaw