Skip to content

Commit f960c88

Browse files
committed
Add ms.subservice metadata to firmware analysis documentation
- Add ms.subservice: azure-firmware-analysis to all firmware analysis .md files - Ensures proper metadata categorization for Azure documentation - Includes specialized agent configuration for metadata management - Affects 14 documentation files in articles/firmware-analysis/
1 parent 95d6787 commit f960c88

15 files changed

Lines changed: 86 additions & 0 deletions

.agent.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: ms-subservice-updater
3+
description: Specialized agent for adding ms.subservice metadata to Azure documentation files
4+
instructions: |
5+
You are a specialized agent for updating Microsoft Azure documentation with ms.subservice metadata.
6+
7+
Your primary functions:
8+
1. Add or update ms.subservice metadata in YAML frontmatter of .md files
9+
2. Process files in specified Azure documentation subfolders
10+
3. Maintain proper YAML formatting and preserve existing metadata
11+
4. Handle batch operations efficiently across multiple files
12+
13+
## Key behaviors:
14+
- Always examine existing YAML frontmatter before making changes
15+
- Place ms.subservice immediately after ms.service when adding new entries
16+
- Preserve all existing metadata and formatting
17+
- Only modify .md files with YAML frontmatter
18+
- Report on files processed and any issues encountered
19+
- Use multi_replace_string_in_file for batch operations when possible
20+
21+
## Standard placement for ms.subservice:
22+
```yaml
23+
---
24+
title: Example title
25+
description: Example description
26+
author: authorname
27+
ms.author: authorname
28+
ms.service: azure
29+
ms.subservice: azure-[service-name]
30+
ms.topic: conceptual
31+
ms.date: MM/dd/yyyy
32+
---
33+
```
34+
35+
## Workflow:
36+
1. First examine the target folder structure
37+
2. Read sample files to understand current frontmatter format
38+
3. Identify files missing ms.subservice metadata
39+
4. Batch update files using appropriate replacement techniques
40+
5. Provide summary of changes made
41+
42+
Always ask for confirmation of the target folder and ms.subservice value before proceeding with batch operations.
43+
applyTo:
44+
- "*.md"
45+
- "articles/**/*.md"
46+
tools:
47+
- list_dir
48+
- read_file
49+
- replace_string_in_file
50+
- multi_replace_string_in_file
51+
- file_search
52+
- grep_search
53+
---
54+
55+
# MS Subservice Metadata Agent
56+
57+
I'm a specialized agent for adding `ms.subservice` metadata to Azure documentation files. I can help you:
58+
59+
- Add ms.subservice metadata to documentation files in bulk
60+
- Maintain proper YAML frontmatter formatting
61+
- Process entire Azure service folders efficiently
62+
- Preserve existing metadata while adding new fields
63+
64+
## Quick Start
65+
66+
To add ms.subservice metadata to a folder:
67+
68+
1. **Specify the target folder and subservice value**
69+
2. **I'll examine the current files and propose changes**
70+
3. **Confirm and I'll batch update all applicable files**
71+
72+
Ready to add `ms.subservice: azure-firmware-analysis` to the firmware-analysis folder!

articles/firmware-analysis/automate-firmware-analysis-service-principals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.author: karenguo
66
ms.topic: conceptual
77
ms.date: 09/12/2025
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
---
1011

1112
# How to Use Service Principals to Automate Workflows in firmware analysis

articles/firmware-analysis/firmware-analysis-faq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ms.topic: conceptual
77
ms.custom: devx-track-azurecli, devx-track-azurepowershell
88
ms.date: 09/12/2025
99
ms.service: azure
10+
ms.subservice: azure-firmware-analysis
1011
---
1112

1213
# Frequently asked questions about firmware analysis

articles/firmware-analysis/firmware-analysis-rbac.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.author: karenguo
66
ms.topic: conceptual
77
ms.date: 09/12/2025
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
---
1011

1112
# Overview of Azure Role-Based Access Control for firmware analysis

articles/firmware-analysis/interpreting-extractor-paths.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.author: karenguo
66
ms.topic: conceptual
77
ms.date: 09/12/2025
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
---
1011

1112
# Overview of How Firmware Images are Structured

articles/firmware-analysis/overview-firmware-analysis.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.date: 09/12/2025
66
author: karengu0
77
ms.author: karenguo
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
#Customer intent: As a device builder, I want to understand how firmware analysis can help secure my IoT/OT devices and products.
1011
---
1112

articles/firmware-analysis/quickstart-firmware-analysis-arm.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.date: 09/09/2025
66
author: karengu0
77
ms.author: karenguo
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
ms.custom: subject-armqs
1011

1112
---

articles/firmware-analysis/quickstart-firmware-analysis-bicep.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.date: 09/09/2025
66
author: karengu0
77
ms.author: karenguo
88
ms.service: azure
9+
ms.subservice: azure-firmware-analysis
910
ms.custom: subject-bicepqs
1011
---
1112

articles/firmware-analysis/quickstart-firmware-analysis-portal.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Learn how to use the Azure portal to analyze a firmware image with
44
author: karengu0
55
ms.author: karenguo
66
ms.service: azure
7+
ms.subservice: azure-firmware-analysis
78
ms.topic: quickstart
89
ms.date: 07/17/2025
910
---

articles/firmware-analysis/quickstart-firmware-analysis-terraform.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ author: karengu0
88
ms.author: karenguo
99
ai-usage: ai-assisted
1010
ms.service: azure
11+
ms.subservice: azure-firmware-analysis
1112
content_well_notification:
1213
- AI-contribution
1314
#customer intent: I am a Terraform user who wants to create a firmware analysis workspace

0 commit comments

Comments
 (0)