Skip to content

Update checklists README with comprehensive documentation#1034

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/fix-1033
Draft

Update checklists README with comprehensive documentation#1034
Copilot wants to merge 3 commits intomainfrom
copilot/fix-1033

Conversation

Copy link
Copy Markdown

Copilot AI commented May 29, 2025

The existing README in the /checklists directory was minimal (only 5 lines) and lacked essential information for contributors. This update provides comprehensive documentation to help users understand and contribute to the Azure review checklists.

What's improved

📋 Overview and Structure

  • Clear explanation of what's in the directory with all file types
  • Documented checklist.en.master.json consolidated file
  • File naming conventions and patterns
  • Complete catalog of 50+ available checklists organized by category
  • Checklist maturity states (GA, Preview, Deprecated)

🛠️ Step-by-step Checklist Creation Guide

  • Complete walkthrough for creating new checklists
  • JSON structure examples with all schema fields (category, text, description, guid, link, training, graph)
  • Detailed field explanations for required and optional properties
  • Schema requirements and validation rules
  • GUID generation instructions
  • Checklist item best practices (actionable, verifiable, specific)

🔍 Azure Resource Graph (ARG) Query Documentation

  • Comprehensive section on ARG queries for automated validation
  • Required output fields (id, compliant)
  • Query syntax best practices
  • Example queries with explanations

✏️ Modification Instructions

  • Two options: direct JSON editing vs Excel spreadsheet
  • Clear guidance on which files to modify (English only)
  • Schema compliance requirements with all field documentation
  • Best practices for creating actionable recommendations

🌍 Localization Guidelines

  • Explanation of automated translation system
  • All supported languages listed (es, ja, ko, pt, zh-Hant)
  • Important warnings about not modifying translated files
  • Why only English versions should be edited

📁 Related Directories

  • New section documenting checklists-ext/ directory
  • Service Guide checklists (15+ specialized checklists)
  • APRL (Azure Proactive Resiliency Library) checklist
  • Full WAF and alternative checklist versions

📖 Usage Methods

  • Three ways to use checklists: Excel, Web App, Azure Resource Graph
  • Links to scripts, workbooks, and spreadsheet documentation

🆘 Help and Support

  • Multiple support channels with direct links to issue templates
  • Links to contributing guidelines, scripts, workbooks, and documentation
  • Community guidelines and quality assurance information

Key improvements

  • Expanded from 5 lines to 286 lines with actionable content (71% increase)
  • Complete checklist catalog with 50+ services organized by category
  • Step-by-step examples with actual JSON snippets and all schema fields
  • Azure Resource Graph documentation for automated compliance validation
  • Direct links to all referenced files and resources (scripts, workbooks, etc.)
  • Clear warnings about localization to prevent common mistakes
  • Multiple help channels for different types of issues
  • Related directories section documenting checklists-ext and Service Guide checklists

All referenced files and links have been verified to exist in the repository.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: sdolgin <576449+sdolgin@users.noreply.github.com>
Copilot AI changed the title [WIP] Update the readme in the checklists directory of the repo Update checklists README with comprehensive documentation May 29, 2025
Copilot AI requested a review from sdolgin May 29, 2025 15:47
@sdolgin
Copy link
Copy Markdown
Collaborator

sdolgin commented Feb 5, 2026

@copilot refresh the readme. It's stale. I need you to review it again.

Co-authored-by: sdolgin <576449+sdolgin@users.noreply.github.com>
Copy link
Copy Markdown
Author

Copilot AI commented Feb 5, 2026

@copilot refresh the readme. It's stale. I need you to review it again.

I've refreshed the README with comprehensive updates in commit 59e5f9f.

Major improvements:

  • Documented all 50+ checklists organized by category (Infrastructure, Data & Analytics, Networking, etc.)
  • Added checklist.en.master.json and all supported language translations
  • Expanded Azure Resource Graph query documentation with requirements and examples
  • Added checklists-ext/ directory documentation (Service Guide checklists, APRL, etc.)
  • Included checklist item best practices (actionable, verifiable, specific)
  • Added all schema fields (description, training, graph, etc.)
  • Expanded from 167 lines to 286 lines with actionable content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants