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.

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

[installer]: add example for post-processing the YAML #7364

Merged
merged 1 commit into from
Jan 3, 2022

Conversation

mrsimonemms
Copy link
Contributor

Description

Document an example of how to post-process the YAML. This should be thought of as a message to the community rather than comprehensive documentation.

Replaces #7280

How to test

Follow instructions.

Release Notes

[installer]: add example for post-processing the YAML

Documentation

@csweichel
Copy link
Contributor

Are we sure we want to point this out? If so, we should make it drastically clear that by going down this path there will be no support available.

@mrsimonemms
Copy link
Contributor Author

@csweichel we have to put something* as there are lots of people in Discord etc saying "I can't do x in the Installer that I could do in Helm and need it for ". For the most part, these are things that we're unlikely to want to add in and certainly not in the short term. By adding an example of what I mean by "you can post-process the YAML", that should reduce the support requests we need to detail

* This is my opinion on "something". I'm happy to debate if it's the correct something

@mrsimonemms
Copy link
Contributor Author

@csweichel I added a "here be dragons" warning to the readme

@csweichel
Copy link
Contributor

@csweichel we have to put something* as there are lots of people in Discord etc saying "I can't do x in the Installer that I could do in Helm and need it for ". For the most part, these are things that we're unlikely to want to add in and certainly not in the short term. By adding an example of what I mean by "you can post-process the YAML", that should reduce the support requests we need to detail

  • This is my opinion on "something". I'm happy to debate if it's the correct something

That makes sense. It also means that for future interactions we need to ask if folks "customised" their rendered YAML.

@corneliusludmann
Copy link
Contributor

With the added warning, I think it's fine to have it in the readme file for now.

/lgtm

@roboquat
Copy link
Contributor

roboquat commented Jan 3, 2022

LGTM label has been added.

Git tree hash: 154067dd1bb3f07c78b8d7e8dc208d8f6cf950a8

@roboquat
Copy link
Contributor

roboquat commented Jan 3, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: corneliusludmann

Associated issue: #7280

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@roboquat roboquat merged commit d4e1f3f into main Jan 3, 2022
@roboquat roboquat deleted the sje/installer-readme-advanced branch January 3, 2022 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved release-note size/S team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants