From 7d7102258bd756666ef2bfaafa76dc8a99fee0ef Mon Sep 17 00:00:00 2001 From: Roi Talpaz <2651169+fokolo@users.noreply.github.com> Date: Wed, 25 Dec 2024 08:51:45 +0200 Subject: [PATCH] Cleanup docs and READMEs Update README.md Update getting-started.md Create all.md Fixed jira docs --- README.md | 113 +++++------------- .../plugins/dev-daily-plugin/README.md | 2 +- docs/site/docs/getting-started.md | 2 + docs/site/docs/integrations/all.md | 7 ++ docs/site/docs/integrations/jira.mdx | 7 +- 5 files changed, 45 insertions(+), 86 deletions(-) create mode 100644 docs/site/docs/integrations/all.md diff --git a/README.md b/README.md index 2f001d88f..fde0c51b6 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,47 @@ Combine all your integrations in one plugin

-# Port Backstage Plugin +# Backstage Plugin Framework by Port -The Port Backstage plugin allows you to use **one plugin** for all your data sources into your Backstage instance. +The **Backstage Plugin Framework** by [Port](https://www.getport.io) will help you build plugins for your Backstage instance faster. -No more wrestling with endless plugin setups, constant upgrades, and cluttered dashboards that slow you as a portal builder and your developers down. +We are also providing a few enterprise-ready example plugins to help you get started. -> [!NOTE] -> This is designed to enhance your Backstage setup, helping you build a better portal more efficiently—not to replace your existing Backstage plugins or Backstage itself. +Building a developer portal from scratch can be a daunting task, but with the **Backstage Plugin Framework** by [Port](https://www.getport.io), you can have a **fully functional portal in days not months**. + +
+ Port Backstage plugin +
+ +With this framework, you can: + +- Build a new plugin with the framework in days and not months +- Use our enterprise-ready [out-of-the-box plugins](https://docs.backstage-plugin.getport.io/examples) to get started faster +- Integrate with 50+ tools and services through Port's extensive integration library +- Use our rules engine to build scorecards which promote standards across your software catalog --- -## Documentation +## Official Documentation + +> [!WARNING]\ +> The Backstage plugin framework by Port is currently in beta and may not be fully stable. Please report any issues or suggestions through our GitHub repository. -Please refer to our [docs](https://port-labs.github.io/backstage-plugin/docs) for installation, usage, customization and tips. +Please refer to our [docs](https://docs.backstage-plugin.getport.io) for installation, usage, customization and tips. ## Screenshots 1. Service view - Added scorecards, actions, and information from integrations.

- Service view

-2. Scorecards view +2. Dev Daily plugin +

+Dev Daily plugin +

+ +3. Scorecards view

Scorecards page

@@ -47,84 +64,14 @@ Integrate your portal with data sources like Jira, PagerDuty, Snyk, AWS, and mor Backstage plugin development often lags behind the needs of modern teams, turning what should be a powerful portal into a messy data dump. Port's plugin changes that by letting you manage everything through a single, flexible plugin. Cutting setup and build time from months to days. -For up to 15 users you can use the free open source version of the plugin and create an account in Port. - -For more than 15 users you need to get a license from [Port](https://backstage-plugin.getport.io/). - ## Getting Started -> [!WARNING]\ -> The Port Backstage plugins are currently in beta and may not be fully stable. Please report any issues or suggestions through our GitHub repository. - -1. **Create 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 - - For up to 15 users, you can use the free version. - -2. **Configure Port Credentials** - - - In Port, on the top right, click on the three dots and select **Credentials** - - Generate API credentials (Client ID and Client Secret) - - 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 - ``` - - [Find your Port credentials](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials) - -3. **Install the Backend and Frontend Plugins** - - Install both plugins using yarn: - - ```bash - # Install backend plugin - yarn --cwd packages/backend add @port-labs/backstage-plugin-framework-backend - - # Install frontend plugin - yarn --cwd packages/app add @port-labs/backstage-plugin-framework - ``` - - Then register the backend plugin in `packages/backend/src/index.ts`: - - ```typescript - backend.add(import("@port-labs/backstage-plugin-framework-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 - } /> - ``` - - and then add the link to the NavBar, in the file: `packages/app/src/components/Root/Root.tsx`: - - ```typescript - - ``` - - ![Scorecards page](docs/site/static/img/scorecards.png) - -4. **Explore Port's API Integration** - - Review the frontend plugin documentation for examples - - Use Port's API to fetch and display data in your Backstage instance - - Leverage Port's data models to customize your views - - Check out our [API documentation](https://docs.getport.io/api-reference/port-api) for more details - -## Repository Structure +To start using the Backstage Plugin Framework by Port, see the [Getting Started](https://docs.backstage-plugin.getport.io/getting-started) documentation. -The repo is organized into two main packages: +## Pricing -1. `backend-plugin`: Contains the backend implementation of the Port Backstage plugin. -2. `frontend-plugin`: Contains the frontend inspiration for what you can build with the Port Backstage plugin, but you can and **should** build your own components. +The Backstage Plugin Framework by Port has a free forever plan and a paid plan for enterprise use. +Visit [Port Pricing](https://backstage-plugin.getport.io/pricing) for more information. ## Support diff --git a/backstage-plugins/plugins/dev-daily-plugin/README.md b/backstage-plugins/plugins/dev-daily-plugin/README.md index da833df70..2380b5138 100644 --- a/backstage-plugins/plugins/dev-daily-plugin/README.md +++ b/backstage-plugins/plugins/dev-daily-plugin/README.md @@ -42,4 +42,4 @@ Track your completed work: ## Installation & Configuration -For detailed installation and configuration instructions, please refer to [Port's official plugin documentation](https://docs.backstage-plugin.getport.io/). +For detailed installation and configuration instructions, please refer to [Port's official plugin documentation](https://docs.backstage-plugin.getport.io/examples/dev-daily). diff --git a/docs/site/docs/getting-started.md b/docs/site/docs/getting-started.md index 748d61fb7..ceb2b6f9c 100644 --- a/docs/site/docs/getting-started.md +++ b/docs/site/docs/getting-started.md @@ -6,6 +6,8 @@ sidebar_position: 2 Let's discover **Port's Backstage plugin in less than 5 minutes**. +By the end of this guide, you will have integrated Jira & Github pull requests into your Backstage instance. + ![Dev Daily Plugin Dashboard](/img/dev-daily/plan-my-day.png) ### Prerequisites diff --git a/docs/site/docs/integrations/all.md b/docs/site/docs/integrations/all.md new file mode 100644 index 000000000..3974808fe --- /dev/null +++ b/docs/site/docs/integrations/all.md @@ -0,0 +1,7 @@ +--- +title: All Integrations +--- + +The framework supports all integrations that are available in Port. + +To see the full list of integrations, visit the [Port Integrations](https://docs.getport.io/build-your-software-catalog/sync-data-to-catalog/#available-plug--play-integrations) documentation. diff --git a/docs/site/docs/integrations/jira.mdx b/docs/site/docs/integrations/jira.mdx index d3824b62d..ac5a1d280 100644 --- a/docs/site/docs/integrations/jira.mdx +++ b/docs/site/docs/integrations/jira.mdx @@ -9,12 +9,15 @@ title: Jira Integration 3. Click on the **Add Integration** button, in the settings page. 4. Scroll down to **Project Management** and select **Jira**. 5. Fill out the form: - - **Name**: Give your integration a name. + - **Name**: Give your integration a name. (You can pick "jira") - **Installation Method**: Select **Hosted by Port**. For more advanced setups, read [here](https://docs.getport.io/build-your-software-catalog/sync-data-to-catalog/project-management/jira/?installation-methods=real-time-self-hosted#setup) - **Jira Host**: Usually it's `https://.atlassian.net`. - **Atlassian User Email**: The email of the user you want to use to authenticate with Jira. - **Atlassian API Token**: The API Token you obtained for the user. 6. Click on the **Save** button. -![Jira Integration](/img/jira-integration.png) +
+ Jira Integration +
+ Read more about Port's Jira integration [here](https://docs.getport.io/build-your-software-catalog/sync-data-to-catalog/project-management/jira/#setup).