Enhance documentation with more details on value types for object attributes #5655
Conversation
This file contains 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
|
Samples:
|
dnsmichi
added
area/documentation
This was referenced Oct 9, 2017
dnsmichi
force-pushed
the
feature/docs-attribute-value-types
branch
from
99526a8
to
0081ddf
Compare
…ributes Main focus: Object attributes and their value types. Originates from the API Event Streams patch to document their value types. Now applied to the entire configuration objects chapter. The API chapter and their value types has been changed to capitalized type identifiers. Value types are now explicitly told about inside monitoring basics. This has been adopted into the Icinga 2 training material a long time ago and finds its way into the docs too. The CheckResult and PerfdataValue value types have been moved into the advanced topics chapter. mkdocs doesn't like multiple `#` headings in one file and did just hide it. Also moved the Influxdb details into the features documentation where it belongs. Many small references and URLs to other chapters added. E.g. dedicated chapters for object accessor examples, to better link against time dependent thresholds. Can serve as patch basis and reference for ITL documentation where the value types are missing too. This commit also fixes the non-requirement of "legacy-timeperiod" which also is a default template import since 2.6. This also fixes the state mapping issue. fixes #4015
dnsmichi
force-pushed
the
feature/docs-attribute-value-types
branch
from
0081ddf
to
2d8607d
Compare
|
More docs changes are incoming with a separate PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Main focus: Object attributes and their value types. Originates from the
API Event Streams patch to document their value types. Now applied to
the entire configuration objects chapter.
The API chapter and their value types has been changed to capitalized
type identifiers.
Value types are now explicitly told about inside monitoring basics. This
has been adopted into the Icinga 2 training material a long time ago
and finds its way into the docs too.
The CheckResult and PerfdataValue value types have been moved into the
advanced topics chapter. mkdocs doesn't like multiple
#headings in one fileand did just hide it.
Also moved the Influxdb details into the features documentation where it
belongs.
Many small references and URLs to other chapters added.
E.g. dedicated chapters for object accessor examples, to better link against
time dependent thresholds.
Can serve as patch basis and reference for ITL documentation where the
value types are missing too.
This commit also fixes the non-requirement of "legacy-timeperiod" which
also is a default template import since 2.6.
This also fixes the state mapping issue.
fixes #4015