Skip to content

Commit 7c4be86

Browse files
authored
Update summaries to bold in RCA documentation
1 parent c6ceba4 commit 7c4be86

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

docs/guides/all/add-rca-context-to-ai-agents.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Follow the steps below to create the blueprint:
4646
4. Copy and paste the JSON schema from below:
4747

4848
<details>
49-
<summary>`Root Cause Analysis` blueprint</summary>
49+
<summary><b>`Root Cause Analysis` blueprint (click to expand)</b></summary>
5050

5151
The entities of this blueprint will represent different RCA documents from past incidents.
5252

@@ -123,7 +123,7 @@ Follow the steps below to create the blueprint:
123123
"relations": {}
124124
}
125125
```
126-
</details>
126+
</details>
127127

128128
5. Click `Create` to save the blueprint.
129129

@@ -151,7 +151,7 @@ Let's create our first RCA entity using the Port UI:
151151

152152
3. Toggle JSON mode and copy and paste the following JSON:
153153
<details>
154-
<summary>Database Connection Pool Exhaustion incident</summary>
154+
<summary><b>Database Connection Pool Exhaustion incident (click to expand)</b></summary>
155155

156156
```json showLineNumbers
157157
{
@@ -191,7 +191,7 @@ Let us add another RCA entity:
191191
2. Toggle JSON mode and copy and paste the following JSON:
192192

193193
<details>
194-
<summary>Memory Leak incident</summary>
194+
<summary><b>Memory Leak incident (click to expand)</b></summary>
195195

196196
```json showLineNumbers
197197
{
@@ -219,7 +219,7 @@ Let us add another RCA entity:
219219
"title": "Memory Leak in User Service Authentication Module"
220220
}
221221
```
222-
</details>
222+
</details>
223223

224224
3. Click `Create` to save the RCA entity.
225225

@@ -341,7 +341,7 @@ else:
341341
**Example integration scenarios:**
342342

343343
<details>
344-
<summary>GitHub Actions workflow</summary>
344+
<summary><b>GitHub Actions workflow (click to expand)</b></summary>
345345

346346
```yaml title=".github/workflows/create-rca.yml"
347347
name: Create RCA from Issue
@@ -390,11 +390,10 @@ jobs:
390390
print(f'RCA created: {response.status_code}')
391391
"
392392
```
393-
394393
</details>
395394
396395
<details>
397-
<summary>Standalone Python script for bulk import</summary>
396+
<summary><b>Standalone Python script for bulk import (click to expand)</b></summary>
398397
399398
```python title="bulk_import_rcas.py"
400399
#!/usr/bin/env python3
@@ -466,7 +465,6 @@ def main():
466465
if __name__ == '__main__':
467466
main()
468467
```
469-
470468
</details>
471469
472470
</TabItem>
@@ -621,21 +619,21 @@ While the agent can automatically access RCA documents, updating the prompt help
621619
5. Replace the existing content with the following:
622620

623621
<details>
624-
<summary>Enhanced agent prompt</summary>
622+
<summary><b>Enhanced agent prompt(click to expand)</b></summary>
623+
624+
```markdown showLineNumbers"
625+
You are an agent responsible for answering questions about PagerDuty incidents, services, escalation policies, schedules, and on-call rotations.
626+
You also have access to historical Root Cause Analysis (RCA) documents from past incidents.
625627
626-
```markdown showLineNumbers"
627-
You are an agent responsible for answering questions about PagerDuty incidents, services, escalation policies, schedules, and on-call rotations.
628-
You also have access to historical Root Cause Analysis (RCA) documents from past incidents.
629-
630-
### Guidelines
631-
- Provide clear information about incidents
632-
- Identify who is on-call for services (both primary and secondary on-call)
633-
- Report on incident statistics and resolution times
634-
- When relevant, reference past RCA documents to provide context and suggest solutions
635-
- Use RCA lessons learned to help prevent similar incidents
636-
- Suggest preventive measures based on historical incident patterns
628+
### Guidelines
629+
- Provide clear information about incidents
630+
- Identify who is on-call for services (both primary and secondary on-call)
631+
- Report on incident statistics and resolution times
632+
- When relevant, reference past RCA documents to provide context and suggest solutions
633+
- Use RCA lessons learned to help prevent similar incidents
634+
- Suggest preventive measures based on historical incident patterns
637635
```
638-
</details>
636+
</details>
639637

640638
6. Click `Save` to save the changes.
641639

@@ -646,19 +644,18 @@ While the agent can automatically access RCA documents, updating the prompt help
646644
2. Replace the existing content with the following:
647645

648646
<details>
649-
<details>
650-
<summary><b>Conversation starters (click to expand)</b></summary>
651-
652-
```json showLineNumbers
653-
[
654-
"Who is on call for the payment service?",
655-
"What are the active incidents right now?",
656-
"What is our average incident resolution time?",
657-
"Have we seen database connection issues before?",
658-
"What can we learn from past payment service incidents?",
659-
"Show me RCAs for incidents similar to the current one"
660-
]
661-
```
647+
<summary><b>Conversation starters (click to expand)</b></summary>
648+
649+
```json showLineNumbers
650+
[
651+
"Who is on call for the payment service?",
652+
"What are the active incidents right now?",
653+
"What is our average incident resolution time?",
654+
"Have we seen database connection issues before?",
655+
"What can we learn from past payment service incidents?",
656+
"Show me RCAs for incidents similar to the current one"
657+
]
658+
```
662659
</details>
663660

664661

@@ -771,4 +768,4 @@ Here are some ways to expand and improve your setup:
771768
- **Cross-reference data**: Link RCAs to services, teams, and other relevant entities using relations.
772769
- **Monitor agent usage**: Review AI invocation logs to see how effectively the agent uses RCA context.
773770
- **Add more context types**: Create additional blueprints for different types of organizational knowledge.
774-
- **Regular maintenance**: Periodically review and update RCA documents as processes evolve.
771+
- **Regular maintenance**: Periodically review and update RCA documents as processes evolve.

0 commit comments

Comments
 (0)