-
Notifications
You must be signed in to change notification settings - Fork 253
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
Add Defender configuration options documentation #1515
Add Defender configuration options documentation #1515
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link doesn't go anywhere:
The sample configuration file also uses Anchors and Aliases...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link doesn't go anywhere:
See the sample configuration file shown in the previous section Defender Configuration...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes sound good.
Good catch. Should have used dashes in place of spaces, not removed them to make the valid link. Fixed in 5587a3d |
Good catch. Should have used dashes in place of spaces, not removed them to make the valid link. Fixed in 5587a3d |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Used the updated documentation to create a new config file with Defender policy specific variables. Worked good and documentation is helpful. Approved.
* Add note about use of anchors and aliases
5587a3d
to
43b44cd
Compare
@nanda-katikaneni Smoke test passed, PR has been approved and rebase. Ready for merge. |
🗣 Description
Expands the existing Defender Configuration section in the docs/configuration.md documentation file to explain the existing Defender policy-specific configuration file options, what they represent, and how to use them.
💭 Motivation and context
Closes #1134
🧪 Testing
This is a documentation only update. The testing is to manually review the updated documentation for grammar, spelling, and clarity.
Additional testing would include running ScubaGear with the example Defender configuration file referenced in the documentation, adjusting the various policy-specific variables referenced in the documentation to confirm what is said in the docs matches the expected operation in ScubaGear.
Note this update includes converting config page absolute links to relative links when referencing sections in the same document or sample configuration files in the repo. Confirm links are not broken.
✅ Pre-approval checklist
Unit tests added/updated to cover PowerShell and Rego changes.Functional tests added/updated to cover PowerShell and Rego changes.✅ Pre-merge checklist
PR passed smoke test check.
Feature branch has been rebased against changes from parent branch, as needed
Use
Rebase branch
button below or use this reference to rebase from the command line.Resolved all merge conflicts on branch
Notified merge coordinator that PR is ready for merge via comment mention
[ ] Demonstrate changes to the team for questions and comments.(Note: Only required for issues of size
Medium
or larger)✅ Post-merge checklist