Fix documentation on global custom variables#10826
Open
julianbrost wants to merge 1 commit into
Open
Conversation
Global custom variables were moved from the global `Vars` constant to the `vars` attribute of the `IcingaApplication` object in v2.4 (84536da), however the documentation wasn't updated accordingly. This commit updates the documentation accordingly. The `vars` attribute of `IcingaApplication` is already documented in `09-object-types.md`, so no addition for this is needed. There is still a reference in `24-appendix.md` that I left unchanged because it is related to the IDO, which is deprecated and scheduled for removal in v2.18, so I didn't bother checking what the IDO actually does in respect to global custom variables.
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
1 participant
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.
Global custom variables were moved from the global
Varsconstant to thevarsattribute of theIcingaApplicationobject in v2.4 (84536da), however the documentation wasn't updated accordingly.See #3238 for a bit of context of the change. The change was also mentioned in the v2.4.0 changelog:
icinga2/CHANGELOG.md
Line 4432 in cf699b2
This commit updates the documentation accordingly. The
varsattribute ofIcingaApplicationis already documented in09-object-types.md, so no addition for this is needed.There is still a reference in
24-appendix.mdthat I left unchanged because it is related to the IDO, which is deprecated and scheduled for removal in v2.18, so I didn't bother checking what the IDO actually does in respect to global custom variables.