Skip to content

Commit

Permalink
docs: add AI technology and guide to navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
1 parent 5031fe4 commit c098455
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
24 changes: 22 additions & 2 deletions docs/guides/all/enrich-security-vulnerabilities-with-ai.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: Enrich security vulnerabilities using AI
displayed_sidebar: null
---

import PortTooltip from "/src/components/tooltip/tooltip.jsx"

# Enrich security vulnerabilities using AI

This guide demonstrates how to leverage 3rd-party AI tools within Port to get additional details on security vulnerabilities and mitigation strategies.
Expand Down Expand Up @@ -82,7 +85,10 @@ We'll add a new markdown field to store AI-generated insights about security vul
2. Click on "New action"
3. Click on "Edit JSON" and paste the following configuration:

```json
<details>
<summary><b>Action Configuration (Click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "enrichSecurityVulnerabilityUsingAI",
"title": "Enrich security vulnerability using AI",
Expand Down Expand Up @@ -125,6 +131,8 @@ We'll add a new markdown field to store AI-generated insights about security vul
}
```

</details>

4. Click "Create" to save the action

## Setup automation
Expand All @@ -135,7 +143,10 @@ To automatically update the security issue with the AI response, we'll create an
2. Click on "New automation"
3. Click on "Edit JSON" and paste the following configuration:

```json
<details>
<summary><b>Automation Configuration (Click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "updateSecurityIssueWithAIResponse",
"title": "Update security issue based on AI",
Expand Down Expand Up @@ -165,6 +176,8 @@ To automatically update the security issue with the AI response, we'll create an
}
```

</details>

4. Click "Create" to save the automation

## Testing the action
Expand All @@ -186,3 +199,10 @@ The summary will include:
- Recommended remediation steps

By following these steps, you've set up an AI-powered system to help developers understand and fix security vulnerabilities more effectively 🎉

:::info AI Integration
The integration uses OpenAI's GPT-3.5 Turbo model by default, but you can modify the configuration to use other AI models:
- Change the `url` in the action configuration to point to your preferred AI service
- Adjust the prompt in the `content` field to match your use case
- Modify the response parsing in the automation if the AI service returns a different format
:::
10 changes: 9 additions & 1 deletion src/components/guides-section/consts.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export const tagsCategoryMap = {
"Humanitec",
"New Relic",
"ServiceNow",
"AI"
]
};

Expand Down Expand Up @@ -869,5 +870,12 @@ export const availableGuides = [
tags: ["Incident management", "GitLab", "Actions", "Automations"],
logos: ["ServiceNow", "GitLab"],
link: "/guides/all/approval-workflow-for-gitlab-deployment"
},
{
title: "Enrich security vulnerabilities using AI",
description: "Use AI to get additional details and mitigation strategies for security vulnerabilities",
tags: ["Security", "AI", "Actions", "Automations"],
logos: ["AI"],
link: "/guides/all/enrich-security-vulnerabilities-with-ai",
}
]
]

0 comments on commit c098455

Please sign in to comment.