Add new Rules documentation that covers YAML Editor view #2407
+27
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: cwillum <cwmmoore@amazon.com>
cwillum
added
3 - Tech review
hdhalter
added
the
release-notes
|
Waiting a while longer for Doc Review to see if I can get a Tech Review first today. |
AWSHurneyt
reviewed
Jan 13, 2023
_security-analytics/usage/rules.md
Outdated
| @@ -17,7 +17,27 @@ When you open the Rules page, all rules are listed in the table. Use the search | |||
| Alternatively, you can use the **Rule type**, **Rule severity**, and **Source** dropdown menus to drill down in the list of alerts and filter for preferred results. You can use all three menus in combination to narrow results. Select only one option per menu. | |||
There was a problem hiding this comment.
Select only one option per menu.
I must have missed this during my initial read of the documentation. The filter menus for this table support selecting multiple options (e.g., the table can be filtered to display only Critical, and Low severity rules).
There was a problem hiding this comment.
Operator error. Yes, pick as many as you'd like. Thanks. Reworded this statement.
_security-analytics/usage/rules.md
Outdated
|
|
||
| If you choose to create the rule manually, you can refer to Sigma's [Rule Creation Guide](https://github.com/SigmaHQ/sigma/wiki/Rule-Creation-Guide) to help understand details for each field. | ||
| * By default, the Visual Editor is displayed. Enter the appropriate content in each field and select **Create** in the lower-right corner of the window to save the rule. | ||
| * the Create a rule window also provides the YAML Editor so that you can create the rule directly in a YAML file format. Select **YAML Editor** and then enter information for the pre-populated field types. |
There was a problem hiding this comment.
Small typo: Should this bullet point start capital T?
Signed-off-by: cwillum <cwmmoore@amazon.com>
cwillum
added
4 - Doc review
AWSHurneyt
approved these changes
Jan 13, 2023
vagimeli
approved these changes
Jan 14, 2023
_security-analytics/usage/rules.md
Outdated
| * By default, the Visual Editor is displayed. Enter the appropriate content in each field and select **Create** in the lower-right corner of the window to save the rule. | ||
| * The Create a rule window also provides the YAML Editor so that you can create the rule directly in a YAML file format. Select **YAML Editor** and then enter information for the pre-populated field types. | ||
|
|
||
| The alternatives to manually creating a rule, however, make the process easier and faster. They involve either importing a rule in a YAML file or duplicating an existing rule and customizing it. See the next two sections for detailed steps. |
There was a problem hiding this comment.
Per the style guide, we should avoid terms like "easier" Suggestion: "..., however, simplify and speed up the process."
_security-analytics/usage/rules.md
Outdated
| <br><img src="{{site.url}}{{site.baseurl}}/images/Security/rule-dup2.png" alt="Opening the rule details pane" width="500"> | ||
| 1. Select the **Duplicate** button in the upper-right corner of the pane. The Duplicate rule window opens in Visual Editor view and all of the fields are automatically populated with the rule's details. Details are also populated in YAML Editor view. | ||
| <br><img src="{{site.url}}{{site.baseurl}}/images/Security/dupe-rule.png" alt="Selecting the duplicate button opens the Duplicate rule window" width="500"> | ||
| 1. In either Visual Editor view or YAML Editor view, modify any of the fields to customize the rule. | ||
| 1. After performing any modifications to the rule, select the **Create** button in the lower-right corner of the window. A new and customized rule is created, and it appears in the list of rules on the main page of the Rules window. |
There was a problem hiding this comment.
Replace double space between "A" and "new" with single space.
Signed-off-by: cwillum <cwmmoore@amazon.com>
4 tasks
vagimeli
pushed a commit
that referenced
this pull request
Jan 25, 2023
* fix#2400-yaml-editor-rules Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-yaml-editor-rules Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-yaml-editor-rules Signed-off-by: cwillum <cwmmoore@amazon.com> Signed-off-by: cwillum <cwmmoore@amazon.com>
vagimeli
added a commit
that referenced
this pull request
Jan 26, 2023
…)" This reverts commit 39fa3b9.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: cwillum cwmmoore@amazon.com
Description
A new YAML Editor view has been added for 2.5 on the Rules page for Security Analytics.
Issues Resolved
Added new content and added or updated screenshots to include the new feature.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.