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

[Docs][Alerting] Changed overall alerting documentation structure #95004

Merged
merged 50 commits into from
Apr 19, 2021
Merged

[Docs][Alerting] Changed overall alerting documentation structure #95004

merged 50 commits into from
Apr 19, 2021

Conversation

YulNaumenko
Copy link
Contributor

@YulNaumenko YulNaumenko commented Mar 19, 2021 •
edited
Loading

Docs link to test: https://kibana_95004.docs-preview.app.elstc.co/guide/en/kibana/master/alerting-getting-started.html
Current PR adding the next changes to the alerting documentation structure:

  1. Moved Connectors to the Stack Management menu from the sub alerts options.
  2. Moved UI documentation for Connector from a separate doc in the Stack Management to the Connectors sub menu
  3. Extended Connectors docs with UI documentation for the existing action types
  4. Moved UI documentation for Alerts from Stack Management to the Alerts sub menu
  5. Updated Stack Management links to the new Alerts and Connector UI docs
  6. Moved Alerting in the Kibana guide menu under the Graph in the list

@YulNaumenko YulNaumenko self-assigned this Mar 19, 2021
@YulNaumenko YulNaumenko linked an issue Mar 19, 2021 that may be closed by this pull request
Review overall alerting documentation structure #90003
Closed
@YulNaumenko YulNaumenko added docs Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0 labels Mar 25, 2021
@YulNaumenko YulNaumenko marked this pull request as ready for review March 26, 2021 00:33
@YulNaumenko YulNaumenko requested a review from a team as a code owner March 26, 2021 00:33
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@ymao1
Copy link
Contributor

ymao1 commented Mar 26, 2021

On the Rules page, Managing Rules and Rule Details have been moved under this in the table of contents, but there is no mention of them on the main page. It might be nice to add a section with links to those pages? Also, would it make more Managing Rules and Rule Details to come before the different rule type descriptions in the table of contents?

@ymao1
Copy link
Contributor

ymao1 commented Mar 26, 2021

Would it make sense to have Managing Connectors come first before all the connector types in the Connectors page?

@ymao1
Copy link
Contributor

ymao1 commented Mar 29, 2021

The Alerting section looks good! I see that Connectors is now a sibling page to Alerting but Managing Connectors is still located under Alerting and not Connectors
Screen Shot 2021-03-29 at 7 41 14 AM

ymao1
ymao1 approved these changes Apr 7, 2021
View reviewed changes
Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM

ymao1
ymao1 reviewed Apr 7, 2021
View reviewed changes
bazel-bin Outdated Show resolved Hide resolved
@YulNaumenko YulNaumenko mentioned this pull request Apr 15, 2021
Merged
@YulNaumenko
Copy link
Contributor Author

@elasticmachine merge upstream

@YulNaumenko
Copy link
Contributor Author

@elasticmachine merge upstream

@YulNaumenko YulNaumenko requested a review from gchaps April 19, 2021 13:46
@YulNaumenko
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 381.0KB 381.0KB -29.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @YulNaumenko

gchaps
gchaps approved these changes Apr 19, 2021
View reviewed changes
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.

Overall docs structure LGTM

@YulNaumenko YulNaumenko merged commit 9cf66a7 into elastic:master Apr 19, 2021
@YulNaumenko YulNaumenko mentioned this pull request Apr 19, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ymao1 ymao1 ymao1 approved these changes

@gchaps gchaps gchaps approved these changes

@mikecote mikecote mikecote approved these changes

@pgayvallet pgayvallet pgayvallet approved these changes

Assignees

@YulNaumenko YulNaumenko

Labels
docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.13.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Review overall alerting documentation structure
7 participants
@YulNaumenko @elasticmachine @ymao1 @kibanamachine @pgayvallet @mikecote @gchaps