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

[Actions][Doc] Clean up Actions README #91789

Merged
merged 11 commits into from
Feb 24, 2021
Merged

Conversation

ymao1
Copy link
Contributor

@ymao1 ymao1 commented Feb 18, 2021

Resolves #64198

Summary

  • Removed Actions API documentation from README since it has been moved to the API docs.
  • Removed action config/secrets/param section from README since it exists in the user docs.
  • Updated Actions and connectors user docs with updated info from README

@ymao1 ymao1 self-assigned this Feb 18, 2021
@ymao1 ymao1 added Feature:Actions 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 labels Feb 18, 2021
@ymao1 ymao1 marked this pull request as ready for review February 18, 2021 03:36
@ymao1 ymao1 requested a review from a team as a code owner February 18, 2021 03:36
@elasticmachine
Copy link
Contributor

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

@ymao1 ymao1 linked an issue Feb 18, 2021 that may be closed by this pull request
2 tasks
@ymao1 ymao1 requested a review from gchaps February 18, 2021 03:41
Copy link
Contributor

@gmmorris gmmorris 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

@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

docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/servicenow.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/servicenow.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/defining-alerts.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/defining-alerts.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/defining-alerts.asciidoc Outdated Show resolved Hide resolved
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.

Stopped at line 127 in the readme.

x-pack/plugins/actions/README.md Outdated Show resolved Hide resolved
x-pack/plugins/actions/README.md Outdated Show resolved Hide resolved
ymao1 and others added 2 commits February 19, 2021 18:43
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@ymao1
Copy link
Contributor Author

ymao1 commented Feb 22, 2021

@elasticmachine merge upstream

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@ymao1 ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label Feb 24, 2021
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

cc @ymao1

@ymao1 ymao1 removed the v7.11.0 label Feb 24, 2021
@ymao1 ymao1 merged commit 69bf127 into elastic:master Feb 24, 2021
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Feb 24, 2021
* Removing REST API from README. Updating configuration docs

* Updating action config docs

* Cleaning up action type configs in README and user docs

* Cleaning up action type configs in README and user docs

* Fixing formatting

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* Update x-pack/plugins/actions/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Feb 24, 2021
* Removing REST API from README. Updating configuration docs

* Updating action config docs

* Cleaning up action type configs in README and user docs

* Cleaning up action type configs in README and user docs

* Fixing formatting

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* Update x-pack/plugins/actions/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine
Copy link
Contributor

💚 Backport successful

7.12 / #92556
7.x / #92557

Successful backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Feb 24, 2021
* Removing REST API from README. Updating configuration docs

* Updating action config docs

* Cleaning up action type configs in README and user docs

* Cleaning up action type configs in README and user docs

* Fixing formatting

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* Update x-pack/plugins/actions/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
kibanamachine added a commit that referenced this pull request Feb 24, 2021
* Removing REST API from README. Updating configuration docs

* Updating action config docs

* Cleaning up action type configs in README and user docs

* Cleaning up action type configs in README and user docs

* Fixing formatting

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* Update x-pack/plugins/actions/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: ymao1 <ying.mao@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 25, 2021
…bana into task-manager/docs-monitoring

* 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: (120 commits)
  Bump the CI Node.js version from 14.15.4 to 14.16.0 (elastic#92578)
  [Uptime] Search made easy (elastic#88581)
  [Lens] Stop requesting stats on Records field (elastic#92508)
  [APM] Correlations style polish in prep for release (elastic#92514)
  [Lens] Fix sorting undefined, null and NaN values (elastic#92575)
  Put environment back in uiFilters (elastic#92561)
  [Discover] Fix sorting by _score behavior (elastic#92132)
  Add metricbeat steps to jenkins_build_load_testing.sh (elastic#90290)
  [Usage Collection] Remove unused UI Metric APIs (elastic#91620)
  Fix timelion deprecation documentation links (elastic#92576)
  [TSVB] Enable `dual mode`, support index patterns and strings (elastic#92395)
  Fix text align in Safari (elastic#92374)
  [Actions][Doc] Clean up Actions README (elastic#91789)
  chore(NA): add missing files to exclude when building bazel prod packages (elastic#92506)
  [Security Solution][Endpoint][Admin] Match Policy Details in Security Solution with Fleet (elastic#92047)
  Revert "[build] Add task skips intended for partial builds (elastic#92076)"
  [Enterprise Search] Change icon for error in EuiCallouts (elastic#92527)
  [Alerts][Docs] Alert types doc update. Added refs to applications specific alerts groups. (elastic#91787)
  [Security Solution][Exceptions] - Update exceptions modal to use existing lists plugin useApi hook (elastic#92348)
  [DOCS] Updates refresh text in index pattern doc (elastic#92469)
  ...
@ymao1 ymao1 deleted the actions/readme branch March 25, 2021 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Actions 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.12.0 v7.13.0 v8.0.0
Projects
None yet
6 participants