Skip to content

Commit 93512c7

Browse files
authored
Merge pull request #2931 from port-labs/PORTN-3707-align-the-docs-with-port-2-0
Portn 3707 align the docs with port 2 0
2 parents be1899e + 7ade930 commit 93512c7

File tree

15 files changed

+68
-67
lines changed

15 files changed

+68
-67
lines changed

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**.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Pages & dashboards",
2+
"label": "Interface designer",
33
"position": 8,
44
"className": "custom-sidebar-item sidebar-menu-pages-and-dashboards"
55
}
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"label": "Engineering 360",
2+
"label": "Engineering intelligence",
33
"collapsible": true,
44
"collapsed": true,
55
"position": 3,
66
"customProps": {
7-
"description": "Engineering 360"
7+
"description": "Engineering intelligence"
88
}
99
}

docs/solutions/engineering-360/overview.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: Overview
33
sidebar_position: 1
44
---
55

6-
# Engineering 360
6+
# Engineering intelligence
77

88
## Why measure engineering effectiveness?
99

1010
Engineering leadership and platform engineers face a critical question: Where should we focus our DevEx efforts to make the biggest impact? With limited resources and competing priorities, identifying the right areas for improvement can mean the difference between meaningful progress and wasted effort.
1111

1212
## The journey
1313

14-
Engineering360 is about avoiding the trap of perfectionism when it comes to analysis, and instead optimizing towards immediate measurement, insights and improvement regardless of the maturity of your Development Platform.
14+
Engineering intelligence is about avoiding the trap of perfectionism when it comes to analysis, and instead optimizing towards immediate measurement, insights and improvement regardless of the maturity of your Development Platform.
1515
In the paragraphs below, we will explore a tried and tested formula for initiating a culture of continuous improvement, in multiple cycles of measurement and improvement.
1616

1717
### Surveys
@@ -52,6 +52,10 @@ A team using Port was able to correlate service complexity (measured by number o
5252
Another customer was able to identify Tribes with a materially faster time to 10th PR metrics and chose to follow up with a secondment of engineering managers to those teams to learn.
5353
:::
5454

55-
Port's flexible data model and managed relations create unique opportunities for measuring sophisticated engineering metrics. Unlike traditional tools that are limited to predefined metrics or siloed data sources, Port can normalize and connect data from across your entire engineering ecosystem. This enables tracking of custom metrics that matter specifically to your organization - whether that's measuring cross-team dependencies, tracking technical debt across multiple repositories, or analyzing the impact of architectural decisions on delivery speed. The managed relations between entities allow for multi-dimensional analysis, helping you understand not just what's happening, but where and why. For example, you could analyze deployment frequency not just by team, but by service type, technology stack, or business domain. This deeper insight helps engineering leaders make more informed decisions about where to focus improvement efforts.
55+
Port's flexible data model and managed relations create unique opportunities for measuring sophisticated engineering metrics. Unlike traditional tools that are limited to predefined metrics or siloed data sources, Port can normalize and connect data from across your entire engineering ecosystem.
56+
57+
This enables tracking of custom metrics that matter specifically to your organization - whether that's measuring cross-team dependencies, tracking technical debt across multiple repositories, or analyzing the impact of architectural decisions on delivery speed.
58+
59+
The managed relations between entities allow for multi-dimensional analysis, helping you understand not just what's happening, but where and why. For example, you could analyze deployment frequency not just by team, but by service type, technology stack, or business domain. This deeper insight helps engineering leaders make more informed decisions about where to focus improvement efforts.
5660

5761
You will learn more about [measuring arbitrary engineering metrics](/solutions/engineering-360/more-engineering-metrics) later in this solution.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"label": "Incident management",
2+
"label": "Self-healing incidents",
33
"collapsible": true,
44
"collapsed": true,
55
"position": 2,
66
"customProps": {
7-
"description": "Incident Management"
7+
"description": "Self-healing incidents"
88
}
99
}

docs/solutions/incident-management/overview.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Overview
33
sidebar_position: 1
44
---
55

6-
# Incident management
6+
# Self-healing incidents
77

88
## Why manage incidents using a developer portal?
99

@@ -12,18 +12,18 @@ Incident management is much more than just selecting a tool for paging and rotat
1212
Imagine you're going to bed on the first night of your first on-call shift at a new company. Predictably, you receive a phone call from an unknown number an some notoriously unfriendly and robotic sounding voice-to-text programme starts reading you an alert description, one syllable at a time.
1313

1414
Your palms sweat, you open your refurbished macbook pro and start logging into everything all at once:
15-
- Pagerduty to see and acknowledge the event
16-
- Slack to start an incident channel and open a bridge for all those investigating
17-
- Dynatrace to explore the telemetry
18-
- Statuspage to be ready to notify customers of impact
19-
- Github to review recent changes
20-
- ArgoCD to review app sync states
21-
- AWS to be ready to do further investigation around the infrastructure, or take actions to remediate
22-
- Notion to start taking notes I'll later use in a post-mortem
15+
- Pagerduty to see and acknowledge the event.
16+
- Slack to start an incident channel and open a bridge for all those investigating.
17+
- Dynatrace to explore the telemetry.
18+
- Statuspage to be ready to notify customers of impact.
19+
- Github to review recent changes.
20+
- ArgoCD to review app sync states.
21+
- AWS to be ready to do further investigation around the infrastructure, or take actions to remediate.
22+
- Notion to start taking notes I'll later use in a post-mortem.
2323

2424
Regardless of whether it's your first on-call or hundredth, the story above highlights the fact that our fragmented toolchains and complex application architecture takes lots of time away from incident triage, investigation and remediation, towards manual tasks around communication and investigation of the incident itself.
2525

26-
![Incident Management Solution Architecture](/img/solutions/incident-management/incident_management_solution_architecture.png)
26+
<img src="/img/solutions/incident-management/incident_management_solution_architecture.png" border='1px' />
2727

2828
## How can Port help?
2929

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"label": "Resource self-service",
2+
"label": "Resource management",
33
"collapsible": true,
44
"collapsed": true,
55
"position": 1,
66
"customProps": {
7-
"description": "Resource Self-Service"
7+
"description": "Resource management"
88
}
99
}

0 commit comments

Comments
 (0)