[Alerts][Docs] Extended README.md and the user docs with the licensing information. #92564
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
YulNaumenko
added
Feature:Alerting
v8.0.0
release_note:skip
lcawl
reviewed
Feb 24, 2021
lcawl
reviewed
Feb 24, 2021
lcawl
reviewed
Feb 24, 2021
gchaps
reviewed
Feb 24, 2021
Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
6 tasks
gmmorris
reviewed
Feb 25, 2021
x-pack/plugins/alerts/README.md
Outdated
Comment on lines
136
to
137
| You should create documentation for the new alert type. Make an entry in the alert type index [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) that points to a new document for the alert type that should be in the directory [`docs/user/alerting/alert-types`](../../../docs/user/alerting/alert-types). | ||
|
|
There was a problem hiding this comment.
Presumably solution specific alert types should be under their directories rather than docs/user/alerting/alert-types/? 🤔
If so, best to clarify that
There was a problem hiding this comment.
I will replace this part with more generic definition. 👍
gmmorris
approved these changes
Feb 25, 2021
gmmorris
reviewed
Feb 25, 2021
x-pack/plugins/alerts/README.md
Outdated
|
|
||
| ## Tests | ||
|
|
||
| The alert type should have both jest tests and functional tests. |
There was a problem hiding this comment.
Is it worth clarifying what should be tested (such as alert specific action groups, parameters etc.) vs. things that we guarantee as a framework and do not need to be independently tested by each alert type? 🤔
gchaps
approved these changes
Feb 25, 2021
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @YulNaumenko |
YulNaumenko
added a commit
to YulNaumenko/kibana
that referenced
this pull request
Feb 25, 2021
…g information. (elastic#92564) * [Alerts][Docs] Extended README.md and the user docs with the licensing information. * Apply suggestions from code review Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * fixed due to comments Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
YulNaumenko
added a commit
to YulNaumenko/kibana
that referenced
this pull request
Feb 25, 2021
…g information. (elastic#92564) * [Alerts][Docs] Extended README.md and the user docs with the licensing information. * Apply suggestions from code review Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * fixed due to comments Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
YulNaumenko
added a commit
that referenced
this pull request
Feb 25, 2021
…g information. (#92564) (#92907) * [Alerts][Docs] Extended README.md and the user docs with the licensing information. * Apply suggestions from code review Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * fixed due to comments Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
YulNaumenko
added a commit
that referenced
this pull request
Feb 25, 2021
…g information. (#92564) (#92908) * [Alerts][Docs] Extended README.md and the user docs with the licensing information. * Apply suggestions from code review Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * fixed due to comments Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Feb 26, 2021
…bana into task-manager/docs-monitoring * 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: (40 commits) [Security Solution][Case][Bug] Improve case logging (elastic#91924) [Alerts][Doc] Added README documentation for alerts plugin status and framework health checks configuration options. (elastic#92761) Add warning for EQL and Threshold rules if exception list contains value list items (elastic#92914) [Security Solution][Case] Fix subcases bugs on detections and case view (elastic#91836) [APM] Always allow access to Profiling via URL (elastic#92889) [Vega] Allow image loading without CORS policy by changing the default to crossOrigin=null (elastic#91991) skip flaky suite (elastic#92114) [APM] Fix for default fields in correlations view (elastic#91868) (elastic#92090) chore(NA): bump bazelisk to v1.7.5 (elastic#92905) [Maps] fix selecting EMS basemap does not populate input (elastic#92711) API docs (elastic#92827) [kbn/test] add import/export support to KbnClient (elastic#92526) Test fix management scripted field filter functional test and unskip it (elastic#92756) [App Search] Create Curation view/functionality (elastic#92560) [Reporting/Discover] include the document's entire set of fields (elastic#92730) [Fleet] Add new index to fleet for artifacts being served out of fleet-server (elastic#92860) [Alerts][Doc] Added README documentation for API key invalidation configuration options. (elastic#92757) [Discover][docs] Add search for relevance (elastic#90611) [Alerts][Docs] Extended README.md and the user docs with the licensing information. (elastic#92564) [7.12][Telemetry] Security telemetry allowlist fix. (elastic#92850) ...
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.
Should provide the missing alerts licensing information added by the PR