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.

Sign up for GitHub

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

Jump to bottom

[Logs UI] [Alerting] Documentation #64886

Merged
merged 3 commits into from
May 4, 2020
Merged

[Logs UI] [Alerting] Documentation #64886

merged 3 commits into from
May 4, 2020

Conversation

Kerry350
Copy link
Contributor

Summary

Adds documentation for logs alerting.

@Kerry350 Kerry350 added Feature:Alerting v8.0.0 Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services release_note:skip Skip the PR/issue when compiling release notes v7.8.0 labels Apr 30, 2020
@Kerry350 Kerry350 requested a review from a team April 30, 2020 12:04
@elasticmachine
Copy link
Contributor

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

weltenwort
weltenwort reviewed May 4, 2020
View reviewed changes
Copy link
Member

@weltenwort weltenwort left a comment

Choose a reason for hiding this comment

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

👀 Reviewing on behalf of @elastic/logs-metrics-ui...

weltenwort
weltenwort approved these changes May 4, 2020
View reviewed changes
Copy link
Member

@weltenwort weltenwort left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to add docs 👍

docs/logs/logs-alerting.asciidoc
@@ -0,0 +1,26 @@
[role="xpack"]
[[xpack-logs-alerting]]
== Logs alerting
Copy link
Member

Choose a reason for hiding this comment

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

This seems to lead to an empty page for the section intro:

image

How about keeping this on one page? I think that could be achieved using [float] markers (see suggestions below). 🤔

docs/logs/logs-alerting.asciidoc Show resolved Hide resolved
docs/logs/logs-alerting.asciidoc Show resolved Hide resolved
@Kerry350
Copy link
Contributor Author

Kerry350 commented May 4, 2020 •
edited
Loading

@weltenwort Thanks for the review 👍 I was hoping you could show me how to get the broken behaviour 🙈 If I build the docs with ./build_docs --doc ~<MY_KIBANA_DIR>/docs/index.asciidoc --open I see the following:

docs

So no empty part? Your [float] suggestions look good. I'd just like to know how to see the broken behaviour first to verify I've fixed it.

@weltenwort
Copy link
Member

That's interesting - I was using the preview created by CI at http://kibana_64886.docs-preview.app.elstc.co/guide/en/kibana/master/xpack-logs-alerting.html.

I assumed that this preview resembles the actually deployed version more closely, but that's just a guess. 🤷

Kerry350 and others added 2 commits May 4, 2020 12:21
@Kerry350 @weltenwort
Update docs/logs/logs-alerting.asciidoc
699e6a3 
Co-authored-by: Felix Stürmer <weltenwort@users.noreply.github.com>
@Kerry350 @weltenwort
Update docs/logs/logs-alerting.asciidoc
730192f 
Co-authored-by: Felix Stürmer <weltenwort@users.noreply.github.com>
@Kerry350
Copy link
Contributor Author

Kerry350 commented May 4, 2020

@weltenwort Ah, I see 🤔 Cool - I've made those changes.

@Kerry350 Kerry350 merged commit 34ccced into elastic:master May 4, 2020
@Kerry350 Kerry350 mentioned this pull request May 4, 2020
Merged
Kerry350 added a commit to Kerry350/kibana that referenced this pull request May 4, 2020
@Kerry350 @weltenwort
[Logs UI] [Alerting] Documentation (elastic#64886)
e6dfc8a 
* Docs for logs alerts

Co-authored-by: Felix Stürmer <weltenwort@users.noreply.github.com>
Kerry350 added a commit that referenced this pull request May 4, 2020
@Kerry350 @weltenwort
[Logs UI] [Alerting] Documentation (#64886) (#65065)
445d703 
* Docs for logs alerts

Co-authored-by: Felix Stürmer <weltenwort@users.noreply.github.com>
gmmorris added a commit to gmmorris/kibana that referenced this pull request May 4, 2020
@gmmorris
Merge branch 'alerting/np-tests-migration' of github.com:gmmorris/kib…
85a6679 
…ana into alerting/np-tests-migration

* 'alerting/np-tests-migration' of github.com:gmmorris/kibana:
  [APM] Agent remote config: validation for Java agent configs (elastic#63956)
  [APM] Fix duplicate index patterns (elastic#64883)
  Drilldowns (elastic#61219)
  [Alerting] fix labels and links in PagerDuty action ui and docs (elastic#64032)
  [Event Log] Ensure sorting tests are less flaky (elastic#64781)
  update endpoint to restrict removing with datasources (elastic#64978)
  [Logs UI] [Alerting] Alerts management page enhancements (elastic#64654)
  Adjust kibana app owning files (elastic#65064)
  Migrate tutorial resources (elastic#64298)
  [Logs UI] Tweak copy in log alerts dialog (elastic#64645)
  [Logs UI] [Alerting] Documentation (elastic#64886)
  [Logs UI] Add dataset filter to ML module setup screen (elastic#64470)
  [TSVB] Fixing memory leak (elastic#64918)
  Bump backport to 5.4.1 (elastic#65041)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weltenwort weltenwort weltenwort approved these changes

Assignees
No one assigned
Labels
Feature:Alerting Feature:Logs UI Logs UI feature release_note:skip Skip the PR/issue when compiling release notes Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.8.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Kerry350 @elasticmachine @weltenwort