Skip to content

Commit d4cbe0d

Browse files
Dhananjayanr98Dhananjayanr98
authored
Merge branch 'main' into patch-34
2 parents f28324a + c743f17 commit d4cbe0d

2,275 files changed

Lines changed: 77842 additions & 56914 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/copilot/skills/extended-zones-article-writer.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Extended Zones Article Writer
2+
3+
Write production-ready how-to, quickstart, tutorial, or overview articles for the Azure Extended Zones Learn documentation.
4+
5+
## Context Sources
6+
7+
### Existing articles (reference for style and structure)
8+
- **Directory:** `C:\github\azure-docs-pr\articles\extended-zones\`
9+
- **Best style reference:** `create-storage-account.md` (canonical how-to example)
10+
- **TOC:** `TOC.yml` — defines the site navigation structure
11+
- **Overview:** `overview.md` — contains the supported services table
12+
13+
### Team code repos (for technical accuracy)
14+
- `C:\github\AzureStack-Fiji-Workloads` — team workloads and service code
15+
- `C:\github\Extended-Zones-Core-Platform` — core platform code
16+
- `C:\github\Fiji-Services-EdgeZoneRP` — Edge Zone resource provider
17+
- `C:\github\Fiji-EdgeZones-TSG-TeamDocs` — troubleshooting and team docs
18+
- `C:\github\EdgeZones-Operations-Configuration` — operations config
19+
- `C:\github\EdgeZones-Operations-Validation` — validation scripts
20+
21+
---
22+
23+
## Frontmatter Template
24+
25+
```yaml
26+
---
27+
title: <Descriptive title — verb + noun + "in an Azure Extended Zone">
28+
description: <One sentence, under 160 characters, starting with "Learn how to...">
29+
author: svaldesgzz
30+
ms.author: svaldes
31+
ms.service: azure-extended-zones
32+
ms.topic: <how-to | quickstart | tutorial | overview | concept-article>
33+
ms.date: <MM/DD/YYYY>
34+
---
35+
```
36+
37+
---
38+
39+
## Article Naming Conventions
40+
41+
| Type | Pattern | Example |
42+
|---|---|---|
43+
| How-to | `[action]-[resource].md` | `create-storage-account.md` |
44+
| Quickstart | `deploy-[resource]-[method].md` | `deploy-vm-portal.md` |
45+
| Tutorial | `[action]-[resource].md` | `backup-virtual-machine.md` |
46+
| Overview | `overview.md` or `[topic]-overview.md` | `overview.md` |
47+
48+
---
49+
50+
## Article Structure by Type
51+
52+
### How-to guide (`ms.topic: how-to`)
53+
1. H1 title
54+
2. Intro paragraph ("In this article, you learn how to...")
55+
3. `## Prerequisites` — subscription, Extended Zone access, tools
56+
4. `## Sign in to Azure` — standard portal sign-in step
57+
5. Main task sections (H2 per major step)
58+
6. `## Clean up resources` — portal resource group deletion
59+
7. `## Related content` — 3–4 bullet links to related articles
60+
61+
### Quickstart (`ms.topic: quickstart`)
62+
Same as how-to but faster-paced, single focused task, ends with a "Next steps" section.
63+
64+
### Tutorial (`ms.topic: tutorial`)
65+
Multi-step, progressive task. Each H2 section builds on the previous one.
66+
67+
---
68+
69+
## Key Formatting Rules
70+
71+
**Tables** (use for all settings/configuration steps):
72+
```markdown
73+
| Setting | Value |
74+
| --- | --- |
75+
| Key vault name | Enter a unique name, such as *myKeyVault*. |
76+
| Region | Select the **parent region** of the target Extended Zone. |
77+
```
78+
79+
**Note/Important/Caution blocks:**
80+
```markdown
81+
> [!NOTE]
82+
> Note text here.
83+
84+
> [!IMPORTANT]
85+
> Critical info here.
86+
87+
> [!CAUTION]
88+
> Warning text here.
89+
```
90+
91+
**Code blocks** — always use language-specific fences:
92+
- Azure CLI: ` ```azurecli `
93+
- PowerShell: ` ```azurepowershell `
94+
- JSON: ` ```json `
95+
- Bash: ` ```bash `
96+
97+
**Cross-links** — use relative paths:
98+
```markdown
99+
[Request access to an Azure Extended Zone](request-access.md)
100+
```
101+
102+
**No screenshots** — use text instructions and tables only (no `:::image` directives).
103+
104+
---
105+
106+
## Extended Zone–Specific Notes
107+
108+
- **Key Vault, Disk Encryption Sets, and most control-plane services** are created in the **parent Azure region**, not the Extended Zone itself.
109+
- **VMs, AKS clusters, storage accounts** are deployed **in the Extended Zone** using `--edge-zone <zone-name>` in the CLI or by selecting "Deploy to an Azure Extended Zone" in the portal under the Region field.
110+
- Always remind users: select the **parent region** first in the portal, then select **Deploy to an Azure Extended Zone** and choose the Extended Zone.
111+
- Storage in Extended Zones is **Premium only** with **LRS** redundancy.
112+
- Refer to `request-access.md` whenever Extended Zone access or zone names are needed.
113+
114+
---
115+
116+
## Publishing Checklist
117+
118+
After writing the article:
119+
120+
1. **Save the file** to `C:\github\azure-docs-pr\articles\extended-zones\<filename>.md`
121+
122+
2. **Update `TOC.yml`** — add an entry under the appropriate section:
123+
```yaml
124+
- name: <Short descriptive name>
125+
href: <filename>.md
126+
```
127+
Sections in TOC: Overview, Quickstarts, Tutorials, Concepts, How-to guides, Arc-enabled PaaS workloads, Security, Reference, Resources
128+
129+
3. **Update `overview.md`** if the article covers a new service — add it to the supported services table under the correct category row (`Compute`, `Networking`, `Storage`, `BCDR`, `Arc-enabled PaaS`, `Other`). Services use `<br>` as separator and are written as markdown links.
130+
131+
4. **Verify frontmatter** — all required fields present (`title`, `description`, `author`, `ms.author`, `ms.service`, `ms.topic`, `ms.date`).

0 commit comments

Comments
 (0)