Skip to content

Commit

Permalink
added more docs structure
Browse files Browse the repository at this point in the history
Added docs
  • Loading branch information
fokolo committed Nov 27, 2024
1 parent c3c7607 commit 2128e31
Show file tree
Hide file tree
Showing 26 changed files with 161 additions and 235 deletions.
2 changes: 1 addition & 1 deletion backend-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

To use these plugins you need to get a license from [Port](https://backstage-plugin.getport.io/)

Read more about the Port Backstage Plugin in the [docs](https://port-labs.github.io/backstage-plugin/docs/intro)
Read more about the Port Backstage Plugin in the [docs](https://port-labs.github.io/backstage-plugin/docs)
12 changes: 0 additions & 12 deletions docs/site/blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions docs/site/blog/2019-05-29-long-blog-post.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/site/blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
29 changes: 0 additions & 29 deletions docs/site/blog/2021-08-26-welcome/index.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/site/blog/authors.yml

This file was deleted.

19 changes: 0 additions & 19 deletions docs/site/blog/tags.yml

This file was deleted.

5 changes: 5 additions & 0 deletions docs/site/docs/customize-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Customize UI
7 changes: 7 additions & 0 deletions docs/site/docs/data-security.md
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).
4 changes: 4 additions & 0 deletions docs/site/docs/examples/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Examples",
"position": 6
}
5 changes: 5 additions & 0 deletions docs/site/docs/examples/jira-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Jira integration
14 changes: 14 additions & 0 deletions docs/site/docs/examples/plugin-catalog.md
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
4 changes: 4 additions & 0 deletions docs/site/docs/features/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Features",
"position": 4
}
5 changes: 5 additions & 0 deletions docs/site/docs/features/actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 4
---

# Actions
5 changes: 5 additions & 0 deletions docs/site/docs/features/automations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 5
---

# Automations
5 changes: 5 additions & 0 deletions docs/site/docs/features/catalog-builder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Catalog builder
5 changes: 5 additions & 0 deletions docs/site/docs/features/integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Integrations
5 changes: 5 additions & 0 deletions docs/site/docs/features/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 6
---

# Notifications
5 changes: 5 additions & 0 deletions docs/site/docs/features/scorecards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Scorecards
81 changes: 81 additions & 0 deletions docs/site/docs/getting-started.md
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).
5 changes: 5 additions & 0 deletions docs/site/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Installation
Loading

0 comments on commit 2128e31

Please sign in to comment.