Skip to content

Commit 4deb6a7

Browse files
[FR] [DaC] Update Readme with DaC Support References (#4526)
* Update Readme with DaC Support References * Patch bump * Call out DaC Pipeline support
1 parent eadcd9d commit 4deb6a7

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ This repository was first announced on Elastic's blog post, [Elastic Security op
2424

2525
## Overview of this repository
2626

27-
Detection Rules contains more than just static rule files. This repository also contains code for unit testing in Python and integrating with the Detection Engine in Kibana.
27+
Detection Rules contains more than just static rule files. This repository also contains code for building Detections-as-code pipelines, unit testing in Python and integrating with the Detection Engine in Kibana.
2828

2929
| folder | description |
3030
|------------------------------------------------ |------------------------------------------------------------------------------------ |
3131
| [`detection_rules/`](detection_rules) | Python module for rule parsing, validating and packaging |
32-
| [`etc/`](detection_rules/etc) | Miscellaneous files, such as ECS and Beats schemas |
33-
| [`hunting/`](./hunting/) | Root directory where threat hunting package and queries are stored |
32+
| [`etc/`](detection_rules/etc) | Miscellaneous files, such as ECS and Beats schemas and configuration files |
33+
| [`hunting/`](./hunting/) | Root directory where threat hunting package and queries are stored |
3434
| [`kibana/`](lib/kibana) | Python library for handling the API calls to Kibana and the Detection Engine |
3535
| [`kql/`](lib/kql) | Python library for parsing and validating Kibana Query Language |
3636
| [`rules/`](rules) | Root directory where rules are stored |
@@ -136,7 +136,7 @@ We welcome your contributions to Detection Rules! Before contributing, please fa
136136

137137
## Detections as Code (DaC)
138138

139-
The Detection Rules repo includes a number of commands to help one manage rules with an "as code" philosophy. We recommend starting with our [DaC Specific Documentation](https://dac-reference.readthedocs.io/en/latest/) for strategies and recommended setup information. However, if you would prefer to jump right in, please see our [custom rules documentation](docs-dev/custom-rules-management.md) for information on how to configure this repo for use with custom rules followed by our [CLI documentation](CLI.md) for information on our commands to import and export rules.
139+
The Detection Rules repo includes a number of commands to help one manage rules with an "as code" philosophy. We recommend starting with our [DaC Specific Documentation](https://dac-reference.readthedocs.io/en/latest/) for strategies and recommended setup information. However, if you would prefer to jump right in, please see our local [detections as code documentation](docs-dev/detections-as-code.md) and [custom rules documentation](docs-dev/custom-rules-management.md) for information on how to configure this repo for use with custom rules followed by our [CLI documentation](CLI.md) for information on our commands to import and export rules.
140140

141141
## RTAs
142142

@@ -156,3 +156,4 @@ Occasionally, we may want to import rules from another repository that already h
156156
- This repository includes new and updated rules that have not been released yet. To see the latest set of rules released with the stack, see the [Prebuilt rule reference](https://www.elastic.co/guide/en/security/current/prebuilt-rules-downloadable-updates.html).
157157
- If you’d like to report a false positive or other type of bug, please create a GitHub issue and check if there's an existing one first.
158158
- Need help with Detection Rules? Post an issue or ask away in our [Security Discuss Forum](https://discuss.elastic.co/c/security/) or the **#security-detection-rules** channel within [Slack workspace](https://www.elastic.co/blog/join-our-elastic-stack-workspace-on-slack).
159+
- For DaC specific cases, pleases see our [support and scope documentation](docs-dev/detections-as-code.md#support-and-scope) for more information.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "detection_rules"
3-
version = "0.4.19"
3+
version = "0.4.20"
44
description = "Detection Rules is the home for rules used by Elastic Security. This repository is used for the development, maintenance, testing, validation, and release of rules for Elastic Security’s Detection Engine."
55
readme = "README.md"
66
requires-python = ">=3.12"

0 commit comments

Comments
 (0)