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

Updates setup guide field API docs #5095

Merged
merged 5 commits into from
Apr 22, 2024
Merged

Updates setup guide field API docs #5095

merged 5 commits into from
Apr 22, 2024

Conversation

dplumlee
Copy link
Contributor

@dplumlee dplumlee commented Apr 16, 2024

API updates for #4917

Relates to: elastic/kibana#173626

Updates related API docs for setup guide field changes made in elastic/kibana#178131

Adds field descriptions and examples to create rule and update rule pages and removes old, unneeded tags.

@dplumlee dplumlee self-assigned this Apr 16, 2024
@dplumlee dplumlee requested a review from a team as a code owner April 16, 2024 03:49
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Apr 16, 2024

This pull request does not have a backport label. Could you fix it @dplumlee? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • v7.x is the label to automatically backport to the 7.x branch.
  • v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot removed the backport-skip label Apr 16, 2024
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

One suggested tweak, in two spots, otherwise LGTM! Thanks so much for putting this together, @dplumlee!

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/rules-api-update.asciidoc Outdated Show resolved Hide resolved
@banderror banderror requested review from a team and xcrzx April 16, 2024 15:44
Copy link
Contributor

@xcrzx xcrzx left a comment

Choose a reason for hiding this comment

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

LGTM

@dplumlee dplumlee requested a review from joepeeples April 22, 2024 14:05
@joepeeples joepeeples merged commit eb739ef into main Apr 22, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Apr 22, 2024
* updates create and update api docs

* addresses comments

---------

Co-authored-by: Joe Peeples <[email protected]>
(cherry picked from commit eb739ef)
@joepeeples joepeeples deleted the setup-guide-api-updates branch April 22, 2024 15:36
joepeeples pushed a commit that referenced this pull request Apr 22, 2024
* updates create and update api docs

* addresses comments

---------

Co-authored-by: Joe Peeples <[email protected]>
(cherry picked from commit eb739ef)

Co-authored-by: Davis Plumlee <[email protected]>
@nikitaindik
Copy link
Contributor

run docs-build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Docset: ESS Issues that apply to docs in the Stack release Feature: Rules Team: Detections/Response Detections and Response v8.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants