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

[Docs] Add geo threshold and containment docs #88783

Merged
merged 27 commits into from
Jan 22, 2021

Conversation

kindsun
Copy link
Contributor

@kindsun kindsun commented Jan 20, 2021

Adds docs for the new Geo containment and Geo threshold alert types. This PR focuses primarily on field descriptions and instructions for alert creation.

We may wish to do a follow-on PR that fleshes out an example, but since that's currently a fairly involved process which is not currently supported by sample data, this should be part of a separate effort.

@kindsun kindsun added Team:Docs [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation v8.0.0 v7.12.0 v7.13.0 labels Jan 20, 2021
@kindsun kindsun requested a review from a team as a code owner January 20, 2021 00:23
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-gis (Team:Geo)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@kindsun kindsun added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes labels Jan 20, 2021
Copy link
Contributor

@YulNaumenko YulNaumenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this doc to show up in the nav, add this line:

include::geo-alert-types.asciidoc[]

to the user/alerting/index.asciidoc

docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
Aaron Caldwell and others added 11 commits January 20, 2021 09:23
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@kindsun kindsun requested review from gchaps and nreese January 20, 2021 21:50
@kindsun
Copy link
Contributor Author

kindsun commented Jan 20, 2021

Great comments/suggestions @nreese @gchaps! Ready for another pass whenever

@gchaps
Copy link
Contributor

gchaps commented Jan 21, 2021

The doc looks good. It still doesn't show up in the nav, though (unless I am looking in the wrong place). Add this line:

include::geo-alert-types.asciidoc[]

to the user/alerting/index.asciidoc

@kindsun
Copy link
Contributor Author

kindsun commented Jan 21, 2021

The doc looks good. It still doesn't show up in the nav, though (unless I am looking in the wrong place). Add this line:

include::geo-alert-types.asciidoc[]

to the user/alerting/index.asciidoc

I'm so sorry, I thought I had. Just updated it! 🙇

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -1,6 +1,6 @@
[role="xpack"]
[[alert-types]]
== Alert types
== Standard stack alert types
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this rename really necessary?

As a user, the word "standard" does not provide a lot of meaning and obscures the real contents "alert types". I would recommend leaving this title as is. I think its ok having a title "alert types" and "geo alert types"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll have to think about this one. I'm open to changing the wording, but it seems strange to me to have a top-level category called "Alert types" and then have another called "Geo alert types". I chose "standard" since these alert types are included at the basic license level and aren't hidden behind a feature flag.

docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/geo-alert-types.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for creating alerting docs

@kindsun kindsun merged commit dc3e1b0 into elastic:master Jan 22, 2021
@kindsun kindsun deleted the docs-geo-alerts branch January 22, 2021 00:00
kindsun pushed a commit that referenced this pull request Jan 25, 2021
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
kindsun pushed a commit that referenced this pull request Feb 16, 2021
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.11.1 v7.12.0 v7.13.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants