Add workbook instructions and validation guide#13961
Merged
Conversation
Add a comprehensive .github/instructions/workbook.instructions.md file that documents standards and validation guidance for Microsoft Sentinel/Azure Monitor workbooks. The new guide specifies required workbook JSON top-level fields (version, items, fallbackResourceIds, fromTemplateId, $schema), provides minimal and full JSON examples, item/parameter/query/chart guidelines, naming and folder conventions, metadata requirements (WorkbooksMetadata.json), versioning rules, common validation errors, and a PR description template to help contributors create and submit valid workbooks.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new contributor instruction guide for Microsoft Sentinel/Azure Monitor workbook JSON files, aiming to standardize required fields, naming, metadata, validation expectations, and PR submission details.
Changes:
- Introduces
.github/instructions/workbook.instructions.mdwith required workbook JSON field guidance and examples - Documents workbook item/parameter/query/chart conventions and common validation errors
- Adds metadata (
WorkbooksMetadata.json) requirements and a PR description template for workbook submissions
Clarify fromTemplateId naming (use sentinel- prefix with descriptive identifier; allow kebab-case or PascalCase and provide filename/vendor/purpose examples) and reorganize examples/rules. Add comprehensive standards for query quality, documentation, visualizations, interactivity/parameters, structure/navigation, and general best practices (including no-data messaging, performance tips, and parameter usage). These updates provide guidance to ensure consistent, performant, and user-friendly workbook templates.
v-atulyadav
previously approved these changes
Apr 8, 2026
rahul0216
reviewed
Apr 8, 2026
Collaborator
rahul0216
left a comment
There was a problem hiding this comment.
Mostly looks good. Please address the inline comments. Dismiss or implement comments provided by copilot with proper justification.
Add an optional description-detailed field to hunting queries guidance to allow extended narrative (>255 chars) with rules and an example. Update workbook instructions to list common item types (add types like multi-select, time range, workspace/subscription selectors, toggle, etc.), include a doc reference, and reorder the Workbook Organization to surface the Help section earlier for clarity.
v-atulyadav
approved these changes
Apr 9, 2026
v-dvedak
approved these changes
Apr 10, 2026
This file contains hidden or 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
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.
Add a comprehensive .github/instructions/workbook.instructions.md file that documents standards and validation guidance for Microsoft Sentinel/Azure Monitor workbooks. The new guide specifies required workbook JSON top-level fields (version, items, fallbackResourceIds, fromTemplateId, $schema), provides minimal and full JSON examples, item/parameter/query/chart guidelines, naming and folder conventions, metadata requirements (WorkbooksMetadata.json), versioning rules, common validation errors, and a PR description template to help contributors create and submit valid workbooks.
Required items, please complete
Change(s):
Reason for Change(s):
Version Updated:
Testing Completed:
Checked that the validations are passing and have addressed any issues that are present:
Guidance <- remove section before submitting
Before submitting this PR please ensure that you have read the following sections and filled out the changes, reason for change and testing complete sections:
Thank you for your contribution to the Microsoft Sentinel Github repo.
Change(s):
Reason for Change(s):
Version updated:
Testing Completed:
Note: If updating a detection, you must update the version field.
Checked that the validations are passing and have addressed any issues that are present:
Note: Let us know if you have tried fixing the validation error and need help.