Skip to content

[FR] Add Documentation on the available custom rules config options #16

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

Conversation

eric-forte-elastic
Copy link
Contributor

Issues

#15

Summary

This PR reconciles recent DAC feature updates with the local documentation in the detection rules repo as well as with the read the docs documentation.

Primary new features added are additional config options for bypass_version_lock and normalize_kql_keywords the exception_dir support was already documented, just not implemented.

Detection Rules PR: elastic/detection-rules#3881

Copy link
Contributor

@Mikaayenson Mikaayenson left a comment

Choose a reason for hiding this comment

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

Do you want to update the exception examples and the CLI commands to push/pull exception lists & merge this after those two PRs are in?

@eric-forte-elastic
Copy link
Contributor Author

eric-forte-elastic commented Jul 10, 2024

Do you want to update the exception examples and the CLI commands to push/pull exception lists & merge this after those two PRs are in?

Yes, will do good idea and prevents the needs for an additional PR for this. Also, we should update the CLI.md in detection rules.

@eric-forte-elastic
Copy link
Contributor Author

eric-forte-elastic commented Jul 12, 2024

I added some quick start examples, but I do not think we have a place in the read the docs where we go over how to use the CLI commands. Should we add one? Or should we defer to the existing documentation in Detection Rules (e.g. CLI.md)?

Update, for now referencing updates made in elastic/detection-rules#3881.

@eric-forte-elastic eric-forte-elastic changed the title FR] Add Documentation on the available custom rules config options [FR] Add Documentation on the available custom rules config options Jul 15, 2024
@Mikaayenson
Copy link
Contributor

Don't forget the example toml files for exception lists.

…onfig-options' of github.com:elastic/DaC-Reference into 15-fr-add-documentation-on-the-available-custom-rules-config-options
@Mikaayenson
Copy link
Contributor

@eric-forte-elastic I dont recall. Were you still planning to update the exception list example configs. Also would be good to add some the examples from the summary of your PR.

@eric-forte-elastic
Copy link
Contributor Author

Put in the FAQ or Exceptions section and known intermittent issue when migrating between stack and how to address it (re-run job). There may be some where the exceptions do not exist and just need to re-run it. We recognize this and do not yet have a complete solution.

@eric-forte-elastic
Copy link
Contributor Author

eric-forte-elastic commented Aug 5, 2024

elastic/detection-rules#3955 (review). Also to add an example actions connector toml file similar to an actions toml file.

@eric-forte-elastic eric-forte-elastic merged commit 59d70bf into main Aug 6, 2024
1 check passed
@eric-forte-elastic eric-forte-elastic deleted the 15-fr-add-documentation-on-the-available-custom-rules-config-options branch August 6, 2024 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FR] Add Documentation on the available custom rules config options
3 participants