Skip to content

Commit 512959e

Browse files
authored
Merge branch 'main' into PORT-16432-bug-add-documentation-for-aws-integration-live-events
2 parents a157180 + 2f09bb4 commit 512959e

File tree

342 files changed

+18059
-5160
lines changed

Some content is hidden

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

342 files changed

+18059
-5160
lines changed

.cursor/rules/documentation_style.mdc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
description:
33
globs:
44
alwaysApply: false
5-
---
6-
5+
---

.github/workflows/verify-docs-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
with:
2323
persist-credentials: true
2424
- name: Install dependencies
25-
uses: actions/setup-node@v5
25+
uses: actions/setup-node@v6
2626
with:
2727
node-version: lts/*
2828
cache: npm

babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

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: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ 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
14-
For real-world examples of self-service actions, check out our [live demo](https://demo.getport.io/self-serve).
13+
For real-world examples of self-service actions, check out our [live demo](https://showcase.port.io/self-serve).
1514
:::
1615

1716
For more information and instructions for creating self-service actions, click [here](/actions-and-automations/create-self-service-experiences).
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: 6 additions & 4 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).
@@ -33,11 +35,11 @@ Port's action model is designed to be flexible and can be used to cover a wide r
3335
- **Rollback** a running service.
3436
- **Change** a deployment's replica count.
3537

36-
In our [live demo](https://demo.getport.io/self-serve), you can see examples for self-service experiences. 🎬
38+
In our [live demo](https://showcase.port.io/self-serve), you can see examples for self-service experiences. 🎬
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/actions-and-automations/create-self-service-experiences/setup-ui-for-action/advanced-form-configurations.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,13 @@ values={[
233233

234234
<TabItem value="visible">
235235

236-
The `visible` property is used to dynamically hide/show inputs in the form.
236+
The `visible` property is used to dynamically hide/show elements in the form.
237237
The `visible` value could be set to either a boolean (`true` value is always shown, `false` value is always hidden), or to a `jqQuery` which evaluates to a boolean.
238238

239+
<h4>Input-level visibility</h4>
240+
241+
You can apply `visible` to individual inputs to control their display:
242+
239243
In this example, the `runArguments` properties are configured with `visible` so that they only show up in the form when the matching value is selected in the `language` input:
240244

241245
<Tabs
@@ -318,6 +322,59 @@ action = Action(
318322

319323
</Tabs>
320324

325+
<h4>Step-level visibility</h4>
326+
327+
You can also apply `visible` to entire steps to control their display:
328+
329+
In this example, the `AWS Configuration` and `Azure Configuration` steps are conditionally shown based on the values selected in the first step's cloud provider input:
330+
331+
<Tabs
332+
defaultValue="api"
333+
values={[
334+
{label: 'API', value: 'api'}
335+
]}>
336+
337+
<TabItem value="api">
338+
339+
```json showLineNumbers
340+
{
341+
"userInputs": {
342+
"properties": {
343+
"enum": {
344+
"icon": "DefaultProperty",
345+
"title": "Cloud provider",
346+
"type": "array",
347+
"items": {
348+
"enum": [ "aws", "azure" ],
349+
"enumColors": { "aws": "red", "azure": "blue" },
350+
"type": "string"
351+
}
352+
}
353+
},
354+
"required": [],
355+
"steps": [
356+
{
357+
"title": "Cloud selection",
358+
"order": [ "enum" ]
359+
},
360+
{
361+
"title": "AWS configuration",
362+
"order": [],
363+
"visible": { "jqQuery": ".form.enum | index(\"aws\") != null" }
364+
},
365+
{
366+
"title": "Azure configuration",
367+
"order": [],
368+
"visible": { "jqQuery": ".form.enum | index(\"azure\") != null" }
369+
}
370+
]
371+
}
372+
}
373+
```
374+
</TabItem>
375+
376+
</Tabs>
377+
321378
</TabItem>
322379

323380
<TabItem value="dependsOn">

docs/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/entity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The entity input type can be used to reference any existing entity from the soft
2121
- Clusters
2222
- Configurations
2323

24-
In the [live demo](https://demo.getport.io/self-serve) self-service hub page, we can see the **scaffold new service** action whose `Domain` input is an entity input. 🎬
24+
In the [live demo](https://showcase.port.io/self-serve) self-service hub page, we can see the **scaffold new service** action whose `Domain` input is an entity input. 🎬
2525

2626
## Sorting entities
2727

docs/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/number.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The number input type can be used to store any numeric data, for example:
2121
- Replica counts
2222
- Number of days to retain data
2323

24-
In the [live demo](https://demo.getport.io/self-serve) self-service hub page, we can see the **scaffold new service** action whose `K8s Replica Count` input is a number input. 🎬
24+
In the [live demo](https://showcase.port.io/self-serve) self-service hub page, we can see the **scaffold new service** action whose `K8s Replica Count` input is a number input. 🎬
2525

2626
## API definition
2727

0 commit comments

Comments
 (0)