Skip to content

Commit 4fb5d2d

Browse files
authored
Merge branch 'main' into setup-the-service-explorer-ai-agent-refactor-guide
2 parents 55d07f5 + 68c17ed commit 4fb5d2d

File tree

138 files changed

+4828
-1302
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+4828
-1302
lines changed

CONTRIBUTING.md renamed to best_practices.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
# Contributing to Port's documentation
1+
# Port documentation style guide
22

3-
Here you can find resources and guidelines on how to contribute to Port's documentation and how to correctly write and fix documentation content.
4-
5-
## How to contribute
6-
7-
The best way to suggest edits for an existing page is by using the "Edit this page" button at the bottom of most docs, this button will take you to the GitHub interface to make and propose changes.
8-
9-
If you want to add a new documentation page, please fork the repository and after adding the new docs, create a PR which will be reviewed by our team.
10-
11-
Contributions are very welcome. If you need help planning your contribution, feel free to ask us by opening an issue in this repository or by writing in our [community Slack](https://join.slack.com/t/getport/shared_invite/zt-1v5z1z1v-3~1Q1Q1).
3+
This document details guidelines for contributing to Port's documentation, and demonstrates how to correctly write and review documentation content.
124

135
## Styling guidelines
146

docs/actions-and-automations/actions-and-automations.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ import PortTooltip from "/src/components/tooltip/tooltip.jsx"
55
One of Port's core offerings is the ability to automate and simplify the processes and routines of your developers.
66
This is done using two powerful tools:
77

8-
## 1. Self-service actions
8+
## 1. Actions
99

10-
Create a wide range of personalized, controlled actions that developers can use to scaffold a service, provision a cloud resource, or any other logic that serves your organization.
11-
Self-service actions drive developer productivity by providing a consistent and repeatable way to perform common tasks, all with guardrails like manual approvals or consumption policies to comply with organizational standards.
10+
Actions are executable pieces of logic that developers or AI agents can run. You can create a wide range of personalized, controlled actions to scaffold a service, provision a cloud resource, or any other logic that serves your organization. Actions drive developer productivity by providing a consistent and repeatable way to perform common tasks, all with guardrails like manual approvals or consumption policies to comply with organizational standards.
1211

1312
:::tip Live demo
1413
For real-world examples of self-service actions, check out our [live demo](https://showcase.port.io/self-serve).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Create self-service actions",
2+
"label": "Create actions",
33
"position": 1
44
}

docs/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ import ExecuteActionLocations from '/docs/actions-and-automations/create-self-se
1414
</center>
1515
<br/>
1616

17-
Drive developer productivity by allowing developers to use self-service actions like scaffolding a service or provisioning a cloud resource. Developer self-service drives consistency and repeatability and ensures that their routines are intuitive and clear, all with guardrails like manual approvals or consumption policies to comply with organizational standards.
17+
Actions are executable pieces of logic that either developers or AI agents can run. They drive developer productivity by enabling them to use actions like scaffolding a service or provisioning a cloud resource.
18+
19+
Actions drive consistency and repeatability and ensure that routines are intuitive and clear, all with guardrails like manual approvals or consumption policies to comply with organizational standards.
1820

1921
Port's action model is designed to be flexible and can be used to cover a wide range of use-cases:
2022

@@ -24,7 +26,7 @@ Port's action model is designed to be flexible and can be used to cover a wide r
2426
4. **Stateful** - every invoked action affects the software catalog by adding/modifying/deleting one or more entities.
2527
5. **Secure by design** - does not require keys to sensitive infrastructure by using an event-based model. All actions are audited and can include guardrails like manual approval and TTL.
2628

27-
## 💡 Common self-service actions
29+
## Common self-service actions
2830

2931
- [**Scaffold** a new service](https://docs.port.io/guides/all/scaffold-a-new-service/).
3032
- [**Create** a cloud resource](https://docs.port.io/guides/all/create-cloud-resource-using-iac).
@@ -37,7 +39,7 @@ In our [live demo](https://showcase.port.io/self-serve), you can see examples fo
3739

3840
## How does it work?
3941

40-
1. A user **executes an action** from Port's UI interface.
42+
1. A user or AI agent **executes an action** from Port's UI interface or through API calls.
4143
2. A pre-defined **payload** containing any desired metadata about the action and its inputs is **sent** to your infrastructure.
4244
3. A **job is triggered** and the user gets a **continuous indication** about its progress.
4345
4. Once the action is running, you can use Port's API to **update Port on its status** and provide information such as **logs and links to the resulting handlers**.

docs/ai-interfaces/ai-chat-widget.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import TabItem from "@theme/TabItem"
99

1010
# AI Chat Widget
1111

12-
:::info Closed Beta
13-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
14-
:::
12+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
13+
14+
<BetaFeatureNotice id="ai-form" />
1515

1616
The AI Chat Widget provides a customizable interface for interacting with [Port AI](/ai-interfaces/port-ai/overview) directly within your dashboards. Platform engineers can configure the widget's prompts, conversation starters, and available developer tools to create tailored AI chat experiences for developers.
1717

docs/ai-interfaces/context-lake.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
sidebar_position: 9
3+
title: Context Lake
4+
sidebar_label: Context Lake
5+
---
6+
7+
import Tabs from "@theme/Tabs"
8+
import TabItem from "@theme/TabItem"
9+
10+
# Context lake
11+
12+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
13+
14+
<BetaFeatureNotice id="ai-form" />
15+
16+
Port's Context Lake is your unified engineering knowledge layer—connecting data from across your entire toolchain into a single, semantically-rich source of truth. It's not a separate feature, but rather the powerful result of Port's core capabilities working together to provide organizational context that AI agents, developers, and workflows can understand and act upon.
17+
18+
## What comprises the context lake
19+
20+
The context lake transforms scattered data across your engineering tools into unified organizational knowledge. It is built from four core components:
21+
22+
### Software catalog - your data
23+
24+
The [software catalog](/build-your-software-catalog) is where you define YOUR organization's data model using blueprints (services, environments, teams, deployments, incidents, etc.) and populate it with entities from all your tools. This catalog becomes your organizational semantic layer—teaching Port what "service," "deployment," or "incident" means specifically in your context, providing the schema and structure that gives meaning to your data.
25+
26+
### Access controls - data governance
27+
28+
[RBAC and permissions](/sso-rbac/rbac-overview) ensure that the right people and systems see the right data. Teams, roles, and policies control who can view, edit, or act on catalog data, maintaining security while enabling collaboration and providing governed access to your organizational knowledge.
29+
30+
### Scorecards - your standards
31+
32+
[Scorecards](/scorecards/overview) define and track your engineering standards, KPIs, and quality metrics. They encode organizational expectations—production readiness requirements, security compliance rules, operational best practices—as measurable criteria within the Context Lake, providing the organizational standards and quality signals that inform decisions.
33+
34+
### Interface layer - how you access it
35+
36+
Context Lake data becomes actionable through multiple interfaces: **[AI Interfaces](/ai-interfaces/overview)** where AI agents and assistants query through [Port MCP Server](/ai-interfaces/port-mcp-server/overview-and-installation) to understand your organization, **[API](/api-reference/port-api)** for programmatic access, and **[Interface Designer](/customize-pages-dashboards-and-plugins/dashboards/)** with dashboards and visualizations that surface insights to your teams—providing multiple ways to query, visualize, and act on your organizational context.
37+
38+
## Why the context lake matters
39+
40+
<Tabs groupId="context-lake-value" queryString>
41+
<TabItem value="ai-agents" label="For AI agents">
42+
43+
Generic AI doesn't understand what "production-ready" means in YOUR organization, who owns which services, or how your deployment pipeline works. Context Lake provides this semantic understanding, enabling AI agents to:
44+
45+
- Answer ownership questions with definitive data (not guesses from code comments).
46+
- Understand dependencies and relationships between services.
47+
- Follow your organization's standards and guardrails when taking actions.
48+
- Make decisions based on real-time operational context.
49+
50+
</TabItem>
51+
<TabItem value="developers" label="For developers">
52+
53+
Instead of hunting across 10 different tools to understand a service's dependencies, ownership, deployment history, or incident timeline, developers get unified context in one place. The Context Lake connects the dots automatically.
54+
55+
**Benefits:**
56+
- Quick access to service ownership and team information.
57+
- Understand dependencies without switching between tools.
58+
- See complete deployment and incident history in context.
59+
- Get AI-powered insights based on your organization's actual data.
60+
61+
</TabItem>
62+
<TabItem value="platform-teams" label="For platform teams">
63+
64+
Define your organizational semantics once—service definitions, environment types, team structures, standards—and every tool, workflow, and AI agent can consume this shared knowledge. No more syncing configurations across systems.
65+
66+
**Benefits:**
67+
- Single source of truth for organizational definitions.
68+
- Consistent standards across all tools and automations.
69+
- Reduced maintenance overhead from duplicate configurations.
70+
- Enable self-service while maintaining governance.
71+
72+
</TabItem>
73+
</Tabs>
74+
75+
## Context lake in action
76+
77+
<Tabs groupId="context-lake-examples" queryString>
78+
<TabItem value="ownership" label="AI agent understanding ownership">
79+
80+
**Developer asks:** "Who owns the payments service?"
81+
82+
- **Without Context Lake:** AI guesses based on code comments or recent contributors.
83+
- **With Context Lake:** AI queries the catalog → sees Team relation → returns the owning team with Slack channel and on-call schedule.
84+
85+
</TabItem>
86+
<TabItem value="provisioning" label="Autonomous service provisioning">
87+
88+
**AI agent needs to provision a dev environment:**
89+
90+
- **Without Context Lake:** Agent doesn't know company's cloud standards, naming conventions, or cost limits.
91+
- **With Context Lake:** Agent queries blueprints → understands allowed regions, naming patterns, tagging requirements → provisions correctly within organizational guardrails.
92+
93+
</TabItem>
94+
<TabItem value="incident" label="Incident response">
95+
96+
**Alert fires:** "payments-api pod crashing"
97+
98+
- **Without Context Lake:** Engineer hunts through Slack, wiki, runbooks across multiple tools.
99+
- **With Context Lake:** Port surfaces: recent deployments, related PRs, dependent services, ownership, SLOs, past incidents—all in unified context for faster resolution.
100+
101+
</TabItem>
102+
</Tabs>
103+
104+
## Getting started
105+
106+
Building your Context Lake is a natural part of setting up Port:
107+
108+
1. **[Define your data model](/build-your-software-catalog)** - Create blueprints that represent your organization's entities.
109+
2. **[Connect your tools](/build-your-software-catalog/sync-data-to-catalog)** - Ingest data from GitHub, Kubernetes, PagerDuty, and 100+ other integrations.
110+
3. **[Set up relationships](/build-your-software-catalog/customize-integrations/configure-mapping#relations)** - Define how entities connect to each other.
111+
4. **[Configure access controls](/sso-rbac/rbac-overview)** - Ensure proper data governance.
112+
5. **[Define standards](/scorecards/overview)** - Create scorecards that encode your quality requirements.
113+
114+
As you build your catalog, you're simultaneously building your Context Lake—the unified knowledge layer that powers intelligent automation and AI-driven workflows.
115+
116+
117+

docs/ai-interfaces/overview.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,23 @@ title: Overview
55

66
# AI Interfaces Overview
77

8-
Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. Our AI capabilities are currently in **open beta**, with AI Agents in **closed beta**.
8+
Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. Our AI capabilities are currently in **open beta**, with Slack App in **closed beta**.
99

1010
We're committed to developing AI responsibly, maintaining high standards of data privacy and security. **[Learn more about our security & data controls →](/ai-interfaces/port-ai/security-and-data-controls)**
1111

12+
## What makes Port's AI different
13+
14+
Port's AI interfaces are powered by its [Context Lake](/ai-interfaces/context-lake) - your unified engineering knowledge layer that connects data from across your entire toolchain. Port's AI understands YOUR organization: your service ownership, deployment patterns, team structures, quality standards, and operational context.
15+
16+
This organizational intelligence enables AI to provide accurate answers about who owns what, make decisions within your governance guardrails, and take actions that align with your engineering standards.
17+
18+
**[Learn more about Context Lake →](/ai-interfaces/context-lake)**
19+
1220
## Port's AI Offerings
1321

14-
:::info Closed Beta
15-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
16-
:::
22+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
23+
24+
<BetaFeatureNotice id="ai-form" />
1725

1826

1927
### Port AI
@@ -42,7 +50,7 @@ Perfect for immediate insights without dedicated customizations. No agents, no c
4250

4351

4452
### AI Agents
45-
Customize and orchestrate complicated workflows inside Port. Build intelligent agents that can be used as part of automations and engineering workflows. **Currently in closed beta.**
53+
Customize and orchestrate complicated workflows inside Port. Build intelligent agents that can be used as part of automations and engineering workflows.
4654

4755
**Use AI Agents to:**
4856
* Automate incident response workflows
@@ -74,7 +82,7 @@ The MCP Server provides AI machine interface capabilities that are compatible wi
7482
**[Set up MCP Server →](/ai-interfaces/port-mcp-server/overview-and-installation)**
7583

7684
### Slack App
77-
Interact with Port's AI capabilities directly from Slack. Ask questions, run actions, and get insights without leaving your team communication platform. **Currently in closed beta.**
85+
Interact with Port's AI capabilities directly from Slack. Ask questions, run actions, and get insights without leaving your team communication platform. **Currently in closed beta** - we are not accepting new applications at the moment and will update once it moves to open beta.
7886

7987
**[Learn about the Slack App →](/ai-interfaces/slack-app)**
8088

@@ -99,7 +107,7 @@ Use the **Slack App** to make AI insights available to your entire team in your
99107

100108
Port offers four main AI interfaces:
101109
- **Port AI Assistant**: Chat interface for quick questions and insights.
102-
- **AI Agents**: Customizable workflows for automations (closed beta).
110+
- **AI Agents**: Customizable workflows for automations.
103111
- **MCP Server**: IDE integration for development workflows.
104112
- **Slack App**: Team collaboration interface (closed beta).
105113
</details>
@@ -119,18 +127,18 @@ For most users, start with **Port AI Assistant** - it provides immediate value w
119127

120128
If you're a developer who works primarily in an IDE, consider starting with the **MCP Server** for seamless integration with your development workflow. **[Set up MCP Server →](/ai-interfaces/port-mcp-server/overview-and-installation)**
121129

122-
For custom workflows or automation, explore **AI Agents** (requires closed beta access). **[Learn about AI Agents →](/ai-interfaces/ai-agents/overview)**
130+
For custom workflows or automation, explore **AI Agents**. **[Learn about AI Agents →](/ai-interfaces/ai-agents/overview)**
123131

124132
For team collaboration, try the **Slack App** to bring AI insights into your communication platform (closed beta). **[Explore Slack App →](/ai-interfaces/slack-app)**
125133
</details>
126134

127135
<details>
128136
<summary>What's the current availability status of Port's AI features? (Click to expand)</summary>
129137

130-
- **Port AI Assistant**: Closed beta - gradually rolling out to users.
138+
- **Port AI Assistant**: Open beta - available to all users.
131139
- **MCP Server**: Open beta - available to all users.
132-
- **AI Agents**: Closed beta - requires application and approval.
133-
- **Slack App**: Closed beta - requires application and approval.
140+
- **AI Agents**: Open beta - available to all users.
141+
- **Slack App**: Closed beta - not accepting new applications at the moment.
134142
</details>
135143

136144
<details>

docs/ai-interfaces/port-ai-assistant.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ sidebar_position: 2
33
title: Port AI Assistant
44
---
55

6+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
7+
68
# Port AI Assistant
79

8-
:::info Closed Beta
9-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
10-
:::
10+
<BetaFeatureNotice id="ai-form" />
1111

1212
The Port AI Assistant is the fastest way to start using AI with Port - no configuration required. Available through a floating chat button, it provides instant, intelligent answers about your software catalog, actions, and Port's capabilities.
1313

docs/ai-interfaces/port-ai/api-interaction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import TabItem from "@theme/TabItem"
88

99
# Port AI API Interaction
1010

11-
:::info Closed Beta
12-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
13-
:::
11+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
12+
13+
<BetaFeatureNotice id="ai-form" />
1414

1515
Port AI can be accessed programmatically through Port's API, enabling integration into custom applications and workflows. This provides the most flexible way to incorporate Port AI capabilities into your existing tools and processes.
1616

docs/ai-interfaces/port-ai/context-engineering.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import TabItem from "@theme/TabItem"
88

99
# Context Engineering with Port AI
1010

11-
:::info Closed Beta
12-
Port's AI offerings are currently in closed beta and will be gradually rolled out to users by the end of 2025.
13-
:::
11+
import BetaFeatureNotice from '/docs/generalTemplates/_beta_feature_notice.md'
12+
13+
<BetaFeatureNotice id="ai-form" />
1414

1515
Context engineering is the practice of constructing an optimal information environment that provides the right amount of directions, tools, and knowledge for AI systems to successfully solve problems. Unlike prompt engineering, which focuses on crafting individual requests, context engineering ensures AI has access to relevant, structured data and capabilities needed for consistent, accurate results.
1616

0 commit comments

Comments
 (0)