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

Add documentation about breaking IOP changes to Helm charts #17

Open
Daniel-WWU-IT opened this issue Aug 30, 2021 · 0 comments
Open

Add documentation about breaking IOP changes to Helm charts #17

Daniel-WWU-IT opened this issue Aug 30, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation Helm IOP

Comments

@Daniel-WWU-IT
Copy link
Member

In order for users to be notified about breaking changes in the IOP deployment (e.g., necessary configuration changes), all these changes can easily be added on a per-version basis to the NOTES.txt file of the IOP Helm templates. Thus, after updating their deployment, the user is able to quickly see whether he needs to update a configuration, whether there were any other breaking changes, like new API specs, etc.

An example entry could look like this:

1.10.0:
 - WOPI secret must be specified in the WOPI values file (see <some link here>)
@Daniel-WWU-IT Daniel-WWU-IT added documentation Improvements or additions to documentation IOP Helm labels Aug 30, 2021
@Daniel-WWU-IT Daniel-WWU-IT changed the title Document breaking changes in IOP charts Add documentation about breaking IOP changes to Helm charts Aug 30, 2021
@SamuAlfageme SamuAlfageme assigned dagl and unassigned SamuAlfageme Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Helm IOP
Projects
None yet
Development

No branches or pull requests

3 participants