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

Expand on ES|QL rule docs #4235

Merged
merged 25 commits into from
Nov 28, 2023
Merged

Expand on ES|QL rule docs #4235

merged 25 commits into from
Nov 28, 2023

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Nov 10, 2023 •
edited
Loading

@nastasha-solomon nastasha-solomon self-assigned this Nov 10, 2023
@github-actions GitHub Actions
Copy link

Documentation previews:

@nastasha-solomon nastasha-solomon marked this pull request as ready for review November 10, 2023 23:57
vitaliidm
vitaliidm reviewed Nov 13, 2023
View reviewed changes
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
@vitaliidm vitaliidm removed their request for review November 15, 2023 09:21
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner November 15, 2023 16:59
@nastasha-solomon nastasha-solomon marked this pull request as draft November 15, 2023 20:35
@nastasha-solomon nastasha-solomon marked this pull request as ready for review November 15, 2023 21:56
joepeeples
joepeeples reviewed Nov 27, 2023
View reviewed changes
Copy link
Contributor

@joepeeples joepeeples left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Added a few small suggested edits, thanks!

Also, sometime soon we might want to think again about splitting up this page into rule types, or something. The ES|QL section alone is getting long, even though this is all necessary info to include. Nothing we need to do now in this PR, of course; looking at the preview just made me realize (again) how long the page is.

docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-ui-create.asciidoc Outdated Show resolved Hide resolved
nastasha-solomon and others added 6 commits November 27, 2023 12:00
@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
3258acb 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
5491f91 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon
Update docs/detections/rules-ui-create.asciidoc
03d2a7a
@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
69a710e 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
5c57d3d 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
3b75f70 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon
Copy link
Contributor Author

Thanks for the thorough review, @joepeeples! I agree that down the line, it might be worth revisiting the way we split up our rule docs. Eventually, I'd like to add more examples and best practices to the ES|QL rule docs, which would make this (already) long page even longer. Maybe we can make this a project for a future Docs OnWeek.

@nastasha-solomon @joepeeples
Update docs/detections/rules-ui-create.asciidoc
e52e402 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nastasha-solomon nastasha-solomon merged commit e463c8d into main Nov 28, 2023
3 checks passed
mergify bot pushed a commit that referenced this pull request Nov 28, 2023
@nastasha-solomon @mergify
Expand on ES|QL rule docs (#4235)
11f79f8 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
(cherry picked from commit e463c8d)
@mergify mergify bot mentioned this pull request Nov 28, 2023
Merged
nastasha-solomon added a commit that referenced this pull request Nov 28, 2023
@mergify @joepeeples @nastasha-solomon
[8.11] Expand on ES|QL rule docs (backport #4235) (#4319)
aef9530 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vitaliidm vitaliidm vitaliidm left review comments

@joepeeples joepeeples joepeeples approved these changes

Assignees

@nastasha-solomon nastasha-solomon

Labels
Team: Detection Engine v8.11.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Expand on ES|QL rule docs
3 participants
@nastasha-solomon @joepeeples @vitaliidm