Skip to content

Expand fixtures documentation with real-world scenarios #2

Description

@juandresrodca

Overview

Enhance docs/fixtures.md to provide comprehensive guidance on how the demo tenant is structured and how contributors can extend it with new scenarios.

Current State

  • How the demo data structure maps to real Intune concepts
  • Step-by-step instructions for adding new scenarios
  • Examples of complex assignment patterns in the fixture data
  • How to validate that new fixtures behave as intended

Goals

Create a detailed fixtures guide that:

  1. Explains the demo architecture - Walk through the Contoso tenant structure (groups, policies, apps, devices)
  2. Documents fixture file format - Show the JSON/data structure and all required fields
  3. Provides scenario templates - Include copy-paste-ready examples for common patterns:
    • Nested group hierarchies
    • Policy include/exclude scenarios
    • Multi-workload assignments
    • Compliance failure conditions
  4. Testing guidance - Show how to validate new fixtures work correctly with existing tests

Example Sections for docs/fixtures.md

  • "Fixture Architecture Overview" - Conceptual diagram and component walkthrough
  • "Common Patterns" - Nested groups, exclusions, multi-targeting, compliance
  • "Validation Checklist" - How to test your changes (run .\build.ps1 -Task Test)
  • "Real-world Examples" - Finance dept, BYOD, Kiosk, etc. with code snippets

Implementation Notes

  • Assume contributors are familiar with Intune but may be new to PowerShell/fixtures
  • Include code examples and configuration samples
  • Link to relevant Intune docs where helpful
  • Keep it actionable and practical, not theoretical

Success Criteria

  • New contributor can add a fixture scenario without asking questions
  • At least 2 detailed end-to-end examples included
  • Testing guidance is clear and executable
  • Document is discoverable from main README

Labels

  • documentation
  • good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions