-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
157 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Customize UI |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# Data handling & security | ||
|
||
Read more about how we handle data and security in the [Port official documentation](https://docs.getport.io/security). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Examples", | ||
"position": 6 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Jira integration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Plugin catalog | ||
|
||
You can build a catalog of the plugins that you have installed in your Backstage instance. | ||
The catalog will contain: | ||
|
||
- A list of all the plugins that you have installed | ||
- A search bar to search for plugins | ||
- A scorecard for each plugin that will show you the status of the plugin | ||
- A status indicator for each plugin | ||
- A kill switch to disable a plugin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Features", | ||
"position": 4 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Actions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Automations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Catalog builder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Integrations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# Notifications |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Scorecards |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Getting Started | ||
|
||
Let's discover **Port's Backstage plugin in less than 5 minutes**. | ||
|
||
### Prerequisites | ||
|
||
- A Backstage instance | ||
- A Port account | ||
- Visit [Port's website](https://www.getport.io) to create your **free** account. | ||
- Follow the onboarding process to set up your organization. | ||
|
||
### Install Plugins | ||
|
||
Install frontend and backend plugins using yarn: | ||
|
||
```bash | ||
# Install backend plugin | ||
yarn add --cwd packages/backend @port-labs/backstage-plugin-port-backend | ||
|
||
# Install frontend plugin | ||
yarn add --cwd packages/app @port-labs/backstage-plugin-port-frontend | ||
``` | ||
|
||
Then register the backend plugin in `packages/backend/src/index.ts`: | ||
|
||
```typescript | ||
backend.add(import("@port-labs/backstage-plugin-port-backend")); | ||
``` | ||
|
||
Finally, add components as you like from the frontend plugin to your Backstage instance. | ||
|
||
For example, let's add the Scorecard component to the NavBar: | ||
|
||
in the file: `packages/app/src/App.tsx`, add the route: | ||
|
||
```typescript | ||
<Route path="/scorecards" element={<ScorecardsPage />} /> | ||
``` | ||
|
||
and then add the link to the NavBar, in the file: `packages/app/src/components/Root/Root.tsx`: | ||
|
||
```typescript | ||
<SidebarItem icon={DoneAllIcon} to="scorecards" text="Scorecards" /> | ||
``` | ||
|
||
![Scorecards page](/img/scorecards.png) | ||
|
||
### Configure Credentials | ||
|
||
1. In Port, on the top right, click on the `...` (three dots) and select **Credentials**. | ||
2. Generate API credentials (Client ID and Client Secret) | ||
3. Add these credentials to your Backstage's `app-config.yaml`: | ||
|
||
```yaml | ||
port: | ||
api: | ||
baseUrl: https://api.getport.io | ||
auth: | ||
clientId: YOUR_CLIENT_ID | ||
clientSecret: YOUR_CLIENT_SECRET | ||
``` | ||
<br /> | ||
Read more [find your Port credentials](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials) | ||
## Extend your Backstage instance | ||
Take your Backstage instance to the next level by integrating with Port's powerful API. | ||
Start by reviewing our frontend plugin documentation to see what's possible. You can: | ||
- Query Port's API to bring rich data into your Backstage views | ||
- Create custom visualizations using Port's flexible data models | ||
- Build tailored experiences for your teams | ||
For complete API capabilities, check out our comprehensive [API documentation](https://docs.getport.io/api-reference/port-api). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Installation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,81 +1,6 @@ | ||
--- | ||
sidebar_position: 1 | ||
slug: / | ||
--- | ||
|
||
# Getting Started | ||
|
||
Let's discover **Port's Backstage plugin in less than 5 minutes**. | ||
|
||
### Prerequisites | ||
|
||
- A Backstage instance | ||
- A Port account | ||
- Visit [Port's website](https://www.getport.io) to create your **free** account. | ||
- Follow the onboarding process to set up your organization. | ||
|
||
### Configure Credentials | ||
|
||
1. In Port, on the top right, click on the `...` (three dots) and select **Credentials**. | ||
2. Generate API credentials (Client ID and Client Secret) | ||
3. Add these credentials to your Backstage's `app-config.yaml`: | ||
|
||
```yaml | ||
port: | ||
api: | ||
baseUrl: https://api.getport.io | ||
auth: | ||
clientId: YOUR_CLIENT_ID | ||
clientSecret: YOUR_CLIENT_SECRET | ||
``` | ||
<br /> | ||
Read more [find your Port credentials](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials) | ||
### Install Plugins | ||
Install frontend and backend plugins using yarn: | ||
```bash | ||
# Install backend plugin | ||
yarn add --cwd packages/backend @port-labs/backstage-plugin-port-backend | ||
|
||
# Install frontend plugin | ||
yarn add --cwd packages/app @port-labs/backstage-plugin-port-frontend | ||
``` | ||
|
||
Then register the backend plugin in `packages/backend/src/index.ts`: | ||
|
||
```typescript | ||
backend.add(import("@port-labs/backstage-plugin-port-backend")); | ||
``` | ||
|
||
Finally, add components as you like from the frontend plugin to your Backstage instance. | ||
|
||
For example, let's add the Scorecard component to the NavBar: | ||
|
||
in the file: `packages/app/src/App.tsx`, add the route: | ||
|
||
```typescript | ||
<Route path="/scorecards" element={<ScorecardsPage />} /> | ||
``` | ||
|
||
and then add the link to the NavBar, in the file: `packages/app/src/components/Root/Root.tsx`: | ||
|
||
```typescript | ||
<SidebarItem icon={DoneAllIcon} to="scorecards" text="Scorecards" /> | ||
``` | ||
|
||
![Scorecards page](/img/scorecards.png) | ||
|
||
## Extend your Backstage instance | ||
|
||
Take your Backstage instance to the next level by integrating with Port's powerful API. | ||
|
||
Start by reviewing our frontend plugin documentation to see what's possible. You can: | ||
|
||
- Query Port's API to bring rich data into your Backstage views | ||
- Create custom visualizations using Port's flexible data models | ||
- Build tailored experiences for your teams | ||
|
||
For complete API capabilities, check out our comprehensive [API documentation](https://docs.getport.io/api-reference/port-api). | ||
# Introduction |