Formatting gallery

Use this gallery as a reference when crafting troubleshooting runbooks with rich Markdown patterns.

Quick reference table

Pattern	Use case	Example snippet
Callout	Highlight critical action	!!! warning
Task list	Track resolution steps	- [ ] Restart service
Code block	Share command sequence	```bash

Callouts and block quotes

Escalate for repeated failures

If the workflow fails more than three times in a row, open a Sev-2 incident. Page the on-call engineer immediately.

Tip: You can nest actionable notes within a quote to show the operator context before the task begins.

Lists and checklists

• Primary steps
• [x] Verify the incident ID
• [ ] Capture relevant logs
• [ ] Update the status page
• Follow-up actions
• File the post-incident report
• Schedule a retrospective meeting
• Share findings with stakeholders

Code and configuration

kubectl logs deploy/opsflw-api --tail=200 | tee opsflw-api.log

alert_rules:
  - name: api-latency-spike
    threshold_ms: 450
    notify: platform-oncall

Inline code such as opsflowctl diagnose helps readers spot precise command names quickly.

Tabs for platform variants

=== "Cloud" Run opsflowctl diagnose --profile cloud to gather managed service diagnostics.

=== "Self-hosted" Run opsflowctl diagnose --profile edge --include=metrics to include Prometheus snapshots.

Definition list and footnote

API gateway | Fronts inbound requests and terminates TLS. Message bus | Buffers event traffic before delivery to processors.

Cite the incident source of truth in every runbook update.¹

Embedding media

Use captions or context paragraphs so operators understand why the media matters.

Task success criteria

1. Document the failure signature in the incident record.
2. Confirm the impacted integration is re-enabled.
3. Close the incident once platform health returns to green across all regions.

Following these patterns keeps troubleshooting content actionable and scannable.

---

1. Link to the incident record in Opsflw Tracker. ↩