Documents revision field and adds a description of version field #3313
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
|
Documentation previews: |
joepeeples
reviewed
May 19, 2023
There was a problem hiding this comment.
Descriptions LGTM! But I don't think we should break the alphabetical order to put related fields next to each other. If the difference between the fields needs to be more explicit, we could add more description or a note, but I'd rather keep the table order consistent and predictable.
That's fair, I'll let the rest of the team weigh in before I change it. |
nastasha-solomon
approved these changes
May 20, 2023
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
spong
reviewed
May 22, 2023
jmikell821
reviewed
May 22, 2023
mergify bot
pushed a commit
that referenced
this pull request
May 23, 2023
* documents revision field and adds a description of version field * Update docs/reference/alert-schema.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Incorporates Garrett's feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 7a5d4cb)
benironside
added a commit
that referenced
this pull request
May 23, 2023
…) (#3352) * documents revision field and adds a description of version field * Update docs/reference/alert-schema.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Incorporates Garrett's feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 7a5d4cb) Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
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.
Fixes #3237 and fixes #3116 by adding the new revision field to the alert schema documentation, and adding a description for the version field. I broke the alphabetical order of the fields in the doc to allow these two closely related fields to be next to each other. Let me know if you think any additional details should be included.
Preview: Alert schema