Skip to content

Commit 74c7ba6

Browse files
committed
Add extension recommendation in README.md
1 parent 0922ef1 commit 74c7ba6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ contentctl build --enrichments
9494

9595
- 🚨 NOTE: If you are just getting started with managing your Splunk detection as code, we recommend that you keep the YAML structure of the detections as close as possible to the original structure of the detections. This will make it easier to manage your detections and will also make it easier to contribute back to the community by creating a pull request to the Splunk Security Content project.
9696

97+
- 🛠️ We strongly recommend installing the [Red Hat YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) for VS Code. This extension provides real-time YAML validation based on contentctl-ng generated schemas, including autocomplete and inline error detection. It helps catch missing fields, invalid fields, and enum options as you type, making content development much faster and reducing errors before running contentctl-ng validate.
98+
9799
- In order to build an content app that specific for your organization, we strongly recommend that you start with keeping only the detections that are related to your organization and remove other yamls that are not related to your organization. This includes selecting detections, stories, macros, lookups that are used by the detection ymls.
98100

99101
- 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.

0 commit comments

Comments
 (0)