Skip to content

Commit d77947e

Browse files
committed
updating logo
1 parent a615f63 commit d77947e

2 files changed

Lines changed: 12 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919

2020
# Splunk Security Content
21-
![security_content](docs/static/logo.png)
21+
![security_content](docs/static/escu_app_logo.png)
2222
=====
2323

2424
Welcome to the Splunk Security Content
@@ -56,12 +56,6 @@ The key tool that drives our content development is [contentctl](https://github.
5656

5757
To learn more about contentctl and its capabilities, please visit the [contentctl repository](https://github.com/splunk/contentctl).
5858

59-
# MITRE ATT&CK ⚔️
60-
### Detection Coverage
61-
To view an up-to-date detection coverage map for all the content tagged with MITRE techniques visit: [https://mitremap.splunkresearch.com/](https://mitremap.splunkresearch.com/) under the **Detection Coverage** layer. Below is a snapshot in time of what technique we currently have some detection coverage for.
62-
63-
![](docs/mitre-map/coverage.png)
64-
6559
# Content Parts 🧩
6660

6761
* [detections/](detections/): Contains all detection searches to-date and growing.
@@ -104,6 +98,7 @@ pip install contentctl
10498
```
10599
contentctl validate
106100
```
101+
**NOTE** - The contentctl validate command ensures that all YAML files adhere to the defined specifications and are up-to-date. It checks for required fields, correct data types, and overall consistency, helping maintain the integrity and quality of the content.
107102

108103
5. Build an ESCU app
109104
```
@@ -121,13 +116,22 @@ contentctl build --enrichments
121116

122117
- If your detections are using macros and lookups, please make sure that you have the same macros and lookups in those directories.. This will ensure that the content app is self-contained and does not rely on external files.
123118

119+
- We recommend that you follow the errors produced by the `contentctl` tool while developing this content. The errors are descriptive enough to guide you in getting the right values. If you need help, please open a GitHub issue in the `contentctl` repository.
120+
124121
# YAML Specs
122+
123+
YAML specs define the structure and required fields for various YAML configuration files used in the project. These specifications ensure consistency and validation across different types of YAML files, such as macros, lookups, and analytic stories. Each spec outlines the expected data types, descriptions, and whether the fields are mandatory, providing a clear schema for developers to follow.
124+
125125
- [detection](https://github.com/splunk/security_content/blob/develop/docs/yaml-spec/detection_spec.yml)
126126
- [stories](https://github.com/splunk/security_content/blob/develop/docs/yaml-spec/stories_spec.yml):
127127
- [macros](https://github.com/splunk/security_content/blob/develop/docs/yaml-spec/macros_spec.yml)
128-
- [lookup](https://github.com/splunk/security_content/blob/develop/docs/yaml-spec/lookups_spec.yml)
128+
- [lookups](https://github.com/splunk/security_content/blob/develop/docs/yaml-spec/lookups_spec.yml)
129+
129130
🚨 NOTE - This directory must contain a lookup.csv file for file based lookups
130131

132+
# MITRE ATT&CK ⚔️
133+
### Detection Coverage
134+
To view an up-to-date detection coverage map for all the content tagged with MITRE techniques visit: [https://mitremap.splunkresearch.com/](https://mitremap.splunkresearch.com/) under the **Detection Coverage** layer. Below is a snapshot in time of what technique we currently have some detection coverage for.
131135

132136
# Contribution 🥰
133137
We welcome feedback and contributions from the community! Please see our [contributing to the project](./.github/CONTRIBUTING.md) for more information on how to get involved.

‎docs/static/escu_app_logo.png‎

19 KB
Loading

0 commit comments

Comments
 (0)