Skip to content

Commit da73ca2

Browse files
Merge pull request #1948 from yt-ms/tweak-advent-text
Tweak advent text
2 parents aa0e7e6 + 8897e44 commit da73ca2

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

advent-of-calm/day-15.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ By adding operational metadata, you transform this into queryable support docume
2929

3030
Unlike static wikis, this documentation lives with the architecture and stays in sync.
3131

32+
Side-note: at the moment we are putting a lot of information into the `metadata` section, but there are some more advanced techniques that we won't discuss here but can be used to do this in a more structured way.
33+
3234
### 2. Add Operational Metadata to Nodes
3335

3436
Enrich your key services with support information.
@@ -222,6 +224,16 @@ Generate an incident summary based on my architecture:
222224
6. Follow-up actions to prevent recurrence
223225
```
224226

227+
228+
Let's keep that for the future:
229+
230+
```
231+
Capture the incident report you just created as a markdown document in `docs/load-balancer-incident-report.md`.
232+
```
233+
234+
To think about: Did you get exactly the same content as when it first generated? Does it depend on which model you used? Does it matter?
235+
236+
225237
### 11. Compare: Wiki vs Architecture-as-Documentation
226238

227239
| Aspect | Traditional Wiki | CALM Architecture |
@@ -236,7 +248,7 @@ Generate an incident summary based on my architecture:
236248
### 12. Commit Your Work
237249

238250
```bash
239-
git add architectures/ecommerce-platform.json
251+
git add architectures/ecommerce-platform.json docs/load-balancer-incident-report.md
240252
git commit -m "Day 15: Add operational metadata for support documentation"
241253
git tag day-15
242254
```

0 commit comments

Comments
 (0)