Commit 39f65be
Add language annotations to codeblocks in resource type descriptions (#267)
## Summary
Codeblocks embedded in the `description` property of many resource types
lacked a language annotation, causing them to render without syntax
highlighting on docs.radapp.io. This adds ` ```bicep ` annotations to
all affected descriptions and documents the requirement in the
contribution guide.
## Reason for change
Unannotated fences (e.g. in `Radius.Compute/containers`) render
incorrectly on docs.radapp.io, unlike the already-correct
`Radius.Compute/containerImages`. Auditing all resource types found 33
unannotated opening fences across 15 files — all Bicep examples.
## How to test
- Verify each modified `*.yaml` still parses and the description renders
with highlighted Bicep in the Radius Dashboard / docs.
- Confirm no opening code fence in any `description` remains without a
language annotation.
## File change summary
| File | Summary of change |
| ---- | ----------------- |
| `Compute/containers/containers.yaml` | Annotate 3 description
codeblocks as `bicep` |
| `Compute/persistentVolumes/persistentVolumes.yaml` | Annotate 4
description codeblocks as `bicep` |
| `Compute/routes/routes.yaml` | Annotate 3 description codeblocks as
`bicep` |
| `Data/redisCaches/redisCaches.yaml` | Annotate 2 description
codeblocks as `bicep` |
| `Data/postgreSqlDatabases/postgreSqlDatabases.yaml` | Annotate 2
description codeblocks as `bicep` |
| `Data/mongoDatabases/mongoDatabases.yaml` | Annotate 2 description
codeblocks as `bicep` |
| `Data/neo4jDatabases/neo4jDatabases.yaml` | Annotate 3 description
codeblocks as `bicep` |
| `Data/sqlServerDatabases/sqlServerDatabases.yaml` | Annotate 2
description codeblocks as `bicep` |
| `Data/mySqlDatabases/mySqlDatabases.yaml` | Annotate 2 description
codeblocks as `bicep` |
| `Messaging/kafka/kafka.yaml` | Annotate 2 description codeblocks as
`bicep` |
| `Messaging/rabbitMQ/rabbitMQ.yaml` | Annotate 1 description codeblock
as `bicep` |
| `AI/search/search.yaml` | Annotate 2 description codeblocks as `bicep`
|
| `AI/models/models.yaml` | Annotate 2 description codeblocks as `bicep`
|
| `Storage/objectStorage/objectStorage.yaml` | Annotate 2 description
codeblocks as `bicep` |
| `Security/secrets/secrets.yaml` | Annotate 1 description codeblock as
`bicep` |
| `docs/contributing/contributing-resource-types-recipes.md` | Require
language annotations on all description codeblocks; convert the
`redisCaches` example from indented to fenced `bicep` blocks |
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes #266
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>1 parent c141bd1 commit 39f65be
16 files changed
Lines changed: 52 additions & 48 deletions
File tree
- AI
- models
- search
- Compute
- containers
- persistentVolumes
- routes
- Data
- mongoDatabases
- mySqlDatabases
- neo4jDatabases
- postgreSqlDatabases
- redisCaches
- sqlServerDatabases
- Messaging
- kafka
- rabbitMQ
- Security/secrets
- Storage/objectStorage
- docs/contributing
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
60 | | - | |
| 60 | + | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
0 commit comments