|
| 1 | +# Content Source Validation Status |
| 2 | + |
| 3 | +This page tracks the source validation status of documentation content, including diagrams and text. All content must be traceable to official Microsoft Learn documentation. |
| 4 | + |
| 5 | +## Summary |
| 6 | + |
| 7 | +*Generated: 2026-04-10* |
| 8 | + |
| 9 | +| Content Type | Total | MS Learn Sourced | Self-Generated | No Source | |
| 10 | +|---|---:|---:|---:|---:| |
| 11 | +| Mermaid Diagrams | 89 | 0 | 0 | 89 | |
| 12 | +| Text Sections | — | — | — | — | |
| 13 | + |
| 14 | +!!! warning "Validation Required" |
| 15 | + All 89 mermaid diagrams require source validation. Content without Microsoft Learn sources must be either: |
| 16 | + |
| 17 | + 1. Linked to an official Microsoft Learn URL, or |
| 18 | + 2. Marked as `self-generated` with clear justification |
| 19 | + |
| 20 | +```mermaid |
| 21 | +pie title Content Source Status |
| 22 | + "Not Validated" : 89 |
| 23 | +``` |
| 24 | + |
| 25 | +## Validation Categories |
| 26 | + |
| 27 | +### Source Types |
| 28 | + |
| 29 | +| Type | Description | Allowed? | |
| 30 | +|---|---|---| |
| 31 | +| `mslearn` | Content directly from Microsoft Learn | Yes | |
| 32 | +| `mslearn-adapted` | Microsoft Learn content adapted for this guide | Yes, with source URL | |
| 33 | +| `self-generated` | Original content created for this guide | Requires justification | |
| 34 | +| `community` | From community sources | Not for core content | |
| 35 | +| `unknown` | Source not documented | Must be validated | |
| 36 | + |
| 37 | +### Diagram Validation Status |
| 38 | + |
| 39 | +All mermaid diagrams are currently marked as not validated. |
| 40 | + |
| 41 | +## How to Validate Content |
| 42 | + |
| 43 | +### Step 1: Add Source Metadata to Frontmatter |
| 44 | + |
| 45 | +Add `content_sources` to the document's YAML frontmatter: |
| 46 | + |
| 47 | +```yaml |
| 48 | +--- |
| 49 | +title: Example Page |
| 50 | +content_sources: |
| 51 | + diagrams: |
| 52 | + - id: architecture-overview |
| 53 | + type: flowchart |
| 54 | + source: mslearn |
| 55 | + mslearn_url: https://learn.microsoft.com/en-us/azure/storage/ |
| 56 | + - id: request-flow |
| 57 | + type: sequence |
| 58 | + source: self-generated |
| 59 | + justification: "Synthesized from multiple Microsoft Learn articles for clarity" |
| 60 | + based_on: |
| 61 | + - https://learn.microsoft.com/en-us/azure/storage/ |
| 62 | + text: |
| 63 | + - section: "## Summary" |
| 64 | + source: mslearn-adapted |
| 65 | + mslearn_url: https://learn.microsoft.com/en-us/azure/storage/ |
| 66 | +--- |
| 67 | +``` |
| 68 | + |
| 69 | +### Step 2: Mark Diagram Blocks with IDs |
| 70 | + |
| 71 | +Add an HTML comment before each mermaid block to identify it: |
| 72 | + |
| 73 | +```markdown |
| 74 | +<!-- diagram-id: architecture-overview --> |
| 75 | +```mermaid |
| 76 | +flowchart TD |
| 77 | + A[Client] --> B[Azure Storage] |
| 78 | +``` |
| 79 | +``` |
| 80 | + |
| 81 | +### Step 3: Run Validation Script |
| 82 | + |
| 83 | +```bash |
| 84 | +python3 scripts/validate_content_sources.py |
| 85 | +``` |
| 86 | + |
| 87 | +### Step 4: Update This Page |
| 88 | + |
| 89 | +```bash |
| 90 | +python3 scripts/generate_content_validation_status.py |
| 91 | +``` |
| 92 | + |
| 93 | +## Validation Rules |
| 94 | + |
| 95 | +!!! danger "Mandatory Rules" |
| 96 | + 1. Platform diagrams (`docs/platform/`) must have Microsoft Learn sources |
| 97 | + 2. Architecture diagrams must reference official Microsoft documentation |
| 98 | + 3. Troubleshooting flowcharts may be self-generated if they synthesize Microsoft Learn content |
| 99 | + 4. Self-generated content must have a `justification` field explaining the source basis |
| 100 | + |
| 101 | +## See Also |
| 102 | + |
| 103 | +- [Validation Status](validation-status.md) |
| 104 | +- [Reference Index](index.md) |
| 105 | + |
| 106 | +## Sources |
| 107 | + |
| 108 | +- [Microsoft Learn: Azure Storage documentation](https://learn.microsoft.com/en-us/azure/storage/) |
0 commit comments