Skip to content

Commit 70fa772

Browse files
author
Kristopher Turner
committed
docs(standards): add Step 8 repository topics to new-repo-setup runbook
1 parent bbc36a7 commit 70fa772

2 files changed

Lines changed: 44 additions & 3 deletions

File tree

azurelocal-github-io.code-workspace

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
},
3939
{
4040
"path": "../azurelocal-ranger"
41+
},
42+
{
43+
"path": "../azurelocal-S2DCartographer"
4144
}
4245
],
4346
"settings": {

standards/new-repo-setup.mdx

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,44 @@ jobs:
167167

168168
---
169169

170-
## Step 8 — Configure Branch Protection
170+
## Step 8 — Add Repository Topics
171+
172+
Topics make the repository discoverable on GitHub and signal at a glance what the solution covers. Set them in **Settings → General → Topics**, or via the `gh` CLI:
173+
174+
```bash
175+
gh api --method PUT repos/AzureLocal/<repo-name>/topics \
176+
--input - <<'EOF'
177+
{"names":["azure-local","azure-stack-hci","azurelocal","azure-arc","powershell","infrastructure-as-code","<solution-specific-tag>"]}
178+
EOF
179+
```
180+
181+
**Required topics for every AzureLocal repo:**
182+
183+
| Topic | Purpose |
184+
|-------|---------|
185+
| `azure-local` | Primary product name |
186+
| `azure-stack-hci` | Legacy/alias for discoverability |
187+
| `azurelocal` | Org tag |
188+
| `azure-arc` | Platform dependency |
189+
| `powershell` | Primary scripting language |
190+
| `infrastructure-as-code` | Deployment model |
191+
192+
**Add solution-specific topics** on top of the required set. Examples:
193+
194+
| Repo | Additional topics |
195+
|------|-------------------|
196+
| azurelocal-avd | `avd`, `azure-virtual-desktop`, `virtual-desktop`, `fslogix` |
197+
| azurelocal-sofs-fslogix | `sofs`, `scale-out-file-server`, `fslogix`, `storage` |
198+
| azurelocal-ranger | `discovery`, `assessment`, `readiness` |
199+
| azurelocal-nutanix-migration | `nutanix`, `migration`, `hyper-v` |
200+
| azurelocal-training | `training`, `lab`, `learning` |
201+
| azurelocal-loadtools | `load-testing`, `performance-testing`, `benchmarking` |
202+
| azurelocal-vm-conversion-toolkit | `vm-migration`, `gen1`, `gen2`, `hyper-v` |
203+
| azurelocal-copilot | `github-copilot`, `ai`, `copilot-instructions`, `developer-tools` |
204+
205+
---
206+
207+
## Step 9 — Configure Branch Protection
171208

172209
In **Settings → Branches**, add a protection rule for `main`:
173210

@@ -184,7 +221,7 @@ In **Settings → Branches**, add a protection rule for `main`:
184221

185222
---
186223

187-
## Step 9 — Add the `ADD_TO_PROJECT_PAT` Secret
224+
## Step 10 — Add the `ADD_TO_PROJECT_PAT` Secret
188225

189226
The add-to-project workflow requires a PAT with `project` scope.
190227

@@ -196,7 +233,7 @@ Paste the shared org PAT when prompted. This token is managed by org admins —
196233

197234
---
198235

199-
## Step 10 — Add the Repository to This Standards Page
236+
## Step 11 — Add the Repository to This Standards Page
200237

201238
Open a PR on `azurelocal.github.io` to:
202239

@@ -217,6 +254,7 @@ Open a PR on `azurelocal.github.io` to:
217254
[ ] release-please.yml slim caller added
218255
[ ] validate-repo-structure.yml slim caller added
219256
[ ] release-please-config.json added
257+
[ ] Repository topics set (required + solution-specific)
220258
[ ] Branch protection configured for main
221259
[ ] ADD_TO_PROJECT_PAT secret set
222260
[ ] Repository listed in repository-management.mdx

0 commit comments

Comments
 (0)