From 21608833faf983482582182595ee108eaebd326f Mon Sep 17 00:00:00 2001 From: chanchalkhatri19 Date: Thu, 12 Mar 2026 12:44:43 +0000 Subject: [PATCH] docs: add missing description frontmatter to golden-path docs Signed-off-by: chanchalkhatri19 --- docs/golden-path/adoption/001-getting-started.md | 1 + docs/golden-path/adoption/002-leadership-buy-in.md | 1 + docs/golden-path/adoption/003-setting-up-a-poc.md | 1 + docs/golden-path/adoption/004-first-stakeholder-feedback.md | 1 + docs/golden-path/adoption/005-customizing-your-instance.md | 1 + docs/golden-path/adoption/006-preparing-for-ga.md | 1 + docs/golden-path/adoption/007-plugin-ownership.md | 1 + docs/golden-path/adoption/008-full-catalog.md | 1 + docs/golden-path/create-app/index.md | 1 + docs/golden-path/create-app/installing-plugins.md | 1 + docs/golden-path/create-app/keeping-backstage-updated.md | 1 + docs/golden-path/create-app/local-development.md | 1 + docs/golden-path/create-app/npx-create-app.md | 1 + docs/golden-path/plugins/backend/001-first-steps.md | 1 + docs/golden-path/plugins/backend/002-poking-around.md | 1 + docs/golden-path/plugins/backend/003-persistence.md | 1 + docs/golden-path/plugins/backend/004-source-tracked.md | 1 + docs/golden-path/plugins/backend/005-testing.md | 1 + docs/golden-path/plugins/frontend/001-first-steps.md | 1 + docs/golden-path/plugins/frontend/002-poking-around.md | 1 + docs/golden-path/plugins/frontend/003-dynamic-config.md | 1 + docs/golden-path/plugins/frontend/004-http-client.md | 1 + docs/golden-path/plugins/frontend/005-testing.md | 1 + docs/golden-path/plugins/index.md | 1 + docs/golden-path/plugins/integrations/001-catalog.md | 1 + docs/golden-path/plugins/integrations/002-search.md | 1 + docs/golden-path/plugins/integrations/003-permissions.md | 1 + docs/golden-path/plugins/integrations/004-notifications.md | 1 + docs/golden-path/plugins/sustainable-plugin-development.md | 1 + docs/golden-path/plugins/why-build-plugins.md | 1 + docs/tutorials/quickstart-app-plugin.md | 1 + 31 files changed, 31 insertions(+) diff --git a/docs/golden-path/adoption/001-getting-started.md b/docs/golden-path/adoption/001-getting-started.md index 574380f263..df5577527b 100644 --- a/docs/golden-path/adoption/001-getting-started.md +++ b/docs/golden-path/adoption/001-getting-started.md @@ -2,6 +2,7 @@ id: getting-started sidebar_label: 001 - Getting started title: Getting started with Backstage +description: An introduction to the Backstage adoption journey and what to expect --- The adoption journey is a bit different than the other Golden Paths. The goal of this guide is to prepare you for a successful implementation of Backstage in your organization. A technical understanding of Backstage is not needed for this Golden Path, just a desire to help the technical team that will be owning your Backstage instance. diff --git a/docs/golden-path/adoption/002-leadership-buy-in.md b/docs/golden-path/adoption/002-leadership-buy-in.md index 502970d3dc..ecb937c6e2 100644 --- a/docs/golden-path/adoption/002-leadership-buy-in.md +++ b/docs/golden-path/adoption/002-leadership-buy-in.md @@ -2,6 +2,7 @@ id: leadership-buy-in sidebar_label: 002 - Leadership buy-in title: Getting leadership buy-in +description: How to build a case for Backstage adoption and secure leadership support --- ## Summary diff --git a/docs/golden-path/adoption/003-setting-up-a-poc.md b/docs/golden-path/adoption/003-setting-up-a-poc.md index 155098c357..6d444de293 100644 --- a/docs/golden-path/adoption/003-setting-up-a-poc.md +++ b/docs/golden-path/adoption/003-setting-up-a-poc.md @@ -2,6 +2,7 @@ id: setting-up-a-poc sidebar_label: 003 - Setting up a PoC title: Setting up a PoC +description: How to set up a proof of concept Backstage instance for your organization --- If you're non-technical, this section should be completed by your technical partner. diff --git a/docs/golden-path/adoption/004-first-stakeholder-feedback.md b/docs/golden-path/adoption/004-first-stakeholder-feedback.md index 6207a49d10..d6cefe9461 100644 --- a/docs/golden-path/adoption/004-first-stakeholder-feedback.md +++ b/docs/golden-path/adoption/004-first-stakeholder-feedback.md @@ -2,6 +2,7 @@ id: first-stakeholder-feedback sidebar_label: 004 - Stakeholder Feedback title: First round of stakeholder feedback +description: How to gather and incorporate stakeholder feedback on your Backstage PoC --- Now that you have a PoC running, let's walk through how to get good feedback. You likely aren't the first person to hear about Backstage or maybe not even the first person to set up a PoC. There may be common pitfalls unique to your company that are worth knowing about - political, organizational or otherwise. diff --git a/docs/golden-path/adoption/005-customizing-your-instance.md b/docs/golden-path/adoption/005-customizing-your-instance.md index 9cc9a98d7a..ca33cba63a 100644 --- a/docs/golden-path/adoption/005-customizing-your-instance.md +++ b/docs/golden-path/adoption/005-customizing-your-instance.md @@ -2,6 +2,7 @@ id: customize-your-instance sidebar_label: 005 - Customizing your instance title: Customizing your instance +description: How to customize your Backstage instance based on user feedback --- You now have the knowledge of what your users want and the go from leadership to continue investing in Backstage. Your job now is to customize your instance for your users to really get the value from. Let's dive in! diff --git a/docs/golden-path/adoption/006-preparing-for-ga.md b/docs/golden-path/adoption/006-preparing-for-ga.md index 0b62f0fa25..6e9db67d65 100644 --- a/docs/golden-path/adoption/006-preparing-for-ga.md +++ b/docs/golden-path/adoption/006-preparing-for-ga.md @@ -2,6 +2,7 @@ id: preparing-for-ga sidebar_label: 006 - Preparing for GA title: Preparing for GA +description: How to prepare your Backstage instance for a company-wide general availability launch --- We hope at this point that the developers you're working with have read the [golden path on deploying Backstage](../deployment/index.md). Your Backstage instance should be ready for the scale that comes with a full company launch. diff --git a/docs/golden-path/adoption/007-plugin-ownership.md b/docs/golden-path/adoption/007-plugin-ownership.md index 17455f19e7..4518e51e95 100644 --- a/docs/golden-path/adoption/007-plugin-ownership.md +++ b/docs/golden-path/adoption/007-plugin-ownership.md @@ -2,6 +2,7 @@ id: plugin-ownership sidebar_label: 007 - Plugin Ownership title: Plugin Ownership +description: How to establish and manage plugin ownership across your organization --- You're now well on your way to a healthy Backstage instance! It's been launched to the whole company and you're loving the feedback developers are giving you. Some developers have even started broaching writing their own plugins. diff --git a/docs/golden-path/adoption/008-full-catalog.md b/docs/golden-path/adoption/008-full-catalog.md index 1725bf6dd2..aa3fae41be 100644 --- a/docs/golden-path/adoption/008-full-catalog.md +++ b/docs/golden-path/adoption/008-full-catalog.md @@ -2,6 +2,7 @@ id: full-catalog sidebar_label: 008 - A Full Catalog title: Ensuring your catalog stays complete +description: Strategies for maintaining a complete and up-to-date software catalog --- Along your Backstage journey (and any workflow migration journey), you will hit a point where incremental adoption is no longer easy. The new developers are no longer flowing into your tool like they once did. More and more projects are not being listed in your catalog. Something has to change. diff --git a/docs/golden-path/create-app/index.md b/docs/golden-path/create-app/index.md index ebd736594d..caa26c2a3a 100644 --- a/docs/golden-path/create-app/index.md +++ b/docs/golden-path/create-app/index.md @@ -1,6 +1,7 @@ --- id: index title: 'Creating your first Backstage app' +description: A guided walkthrough for creating and setting up your first Backstage application --- ### Prerequisites diff --git a/docs/golden-path/create-app/installing-plugins.md b/docs/golden-path/create-app/installing-plugins.md index ab1e1a68c5..f5f5931220 100644 --- a/docs/golden-path/create-app/installing-plugins.md +++ b/docs/golden-path/create-app/installing-plugins.md @@ -2,6 +2,7 @@ id: installing-plugins sidebar_label: 003 - Installing plugins title: 003 - Installing plugins +description: How to find and install plugins in your Backstage app --- Now that you have a working Backstage app, let's walk through the most valuable part of the Backstage ecosystem - plugins! diff --git a/docs/golden-path/create-app/keeping-backstage-updated.md b/docs/golden-path/create-app/keeping-backstage-updated.md index de7d99b2b8..1747a82a3e 100644 --- a/docs/golden-path/create-app/keeping-backstage-updated.md +++ b/docs/golden-path/create-app/keeping-backstage-updated.md @@ -2,6 +2,7 @@ id: keeping-backstage-updated sidebar_label: 006 - Keep Backstage updated title: 006 - Keeping Backstage up to date +description: How to keep your Backstage instance up to date with the latest releases --- Audience: Developers and Admins diff --git a/docs/golden-path/create-app/local-development.md b/docs/golden-path/create-app/local-development.md index 2c81c2c643..ff23a7c652 100644 --- a/docs/golden-path/create-app/local-development.md +++ b/docs/golden-path/create-app/local-development.md @@ -1,6 +1,7 @@ --- id: local-development title: 002 - Local development +description: How to run and develop your Backstage app locally --- Your Backstage app is fully installed and ready to be run! Now that the installation is complete, you can go to the application directory and start the app using the `yarn start` command. The `yarn start` command will run both the frontend and backend as separate processes (named `[0]` and `[1]`) in the same window. diff --git a/docs/golden-path/create-app/npx-create-app.md b/docs/golden-path/create-app/npx-create-app.md index 8ee016f41f..d33c037424 100644 --- a/docs/golden-path/create-app/npx-create-app.md +++ b/docs/golden-path/create-app/npx-create-app.md @@ -1,6 +1,7 @@ --- id: npx-create-app title: '001 - Scaffolding' +description: How to scaffold a new Backstage app using create-app --- Audience: Developers and Admins diff --git a/docs/golden-path/plugins/backend/001-first-steps.md b/docs/golden-path/plugins/backend/001-first-steps.md index 8a0defe183..ed2c8e98ed 100644 --- a/docs/golden-path/plugins/backend/001-first-steps.md +++ b/docs/golden-path/plugins/backend/001-first-steps.md @@ -2,6 +2,7 @@ id: first-steps sidebar_label: 001 - Scaffolding the plugin title: How to scaffold a new plugin? +description: How to scaffold a new Backstage backend plugin using the CLI --- # Scaffolding a new plugin diff --git a/docs/golden-path/plugins/backend/002-poking-around.md b/docs/golden-path/plugins/backend/002-poking-around.md index 596de01b4b..e7636d3749 100644 --- a/docs/golden-path/plugins/backend/002-poking-around.md +++ b/docs/golden-path/plugins/backend/002-poking-around.md @@ -2,6 +2,7 @@ id: poking-around sidebar_label: 002 - Poking around title: 002 - Poking around +description: Exploring the default backend plugin structure and functionality --- ## Default plugin functionality diff --git a/docs/golden-path/plugins/backend/003-persistence.md b/docs/golden-path/plugins/backend/003-persistence.md index ba00b2f417..60d275d7ec 100644 --- a/docs/golden-path/plugins/backend/003-persistence.md +++ b/docs/golden-path/plugins/backend/003-persistence.md @@ -2,6 +2,7 @@ id: persistence sidebar_label: 003 - Persisting your TODOs title: 003 - Persisting your TODOs +description: How to add database persistence to your backend plugin --- ## Saving Plugin State Indefinitely diff --git a/docs/golden-path/plugins/backend/004-source-tracked.md b/docs/golden-path/plugins/backend/004-source-tracked.md index 074cc85cf1..54013ccead 100644 --- a/docs/golden-path/plugins/backend/004-source-tracked.md +++ b/docs/golden-path/plugins/backend/004-source-tracked.md @@ -2,6 +2,7 @@ id: source-tracked sidebar_label: 004 - Integrating with SCMs title: 004 - Git-tracked TODOs +description: How to ingest TODOs from source code repositories into your plugin --- Problem: You have TODOs in your source code that you want to ingest with your plugin. diff --git a/docs/golden-path/plugins/backend/005-testing.md b/docs/golden-path/plugins/backend/005-testing.md index 9643e8a487..075b81f1fc 100644 --- a/docs/golden-path/plugins/backend/005-testing.md +++ b/docs/golden-path/plugins/backend/005-testing.md @@ -2,6 +2,7 @@ id: testing sidebar_label: 005 - Unit testing your plugin title: 005 - Testing +description: How to write unit tests for your Backstage backend plugin --- ## Testing is important diff --git a/docs/golden-path/plugins/frontend/001-first-steps.md b/docs/golden-path/plugins/frontend/001-first-steps.md index d6c21ed053..313a990b62 100644 --- a/docs/golden-path/plugins/frontend/001-first-steps.md +++ b/docs/golden-path/plugins/frontend/001-first-steps.md @@ -2,6 +2,7 @@ id: first-steps sidebar_label: 001 - Scaffolding the plugin title: How to scaffold a new plugin? +description: How to scaffold a new Backstage frontend plugin using the CLI --- Running `yarn new` -> `frontend-plugin`. diff --git a/docs/golden-path/plugins/frontend/002-poking-around.md b/docs/golden-path/plugins/frontend/002-poking-around.md index e85ea235f3..33223019d0 100644 --- a/docs/golden-path/plugins/frontend/002-poking-around.md +++ b/docs/golden-path/plugins/frontend/002-poking-around.md @@ -2,6 +2,7 @@ id: poking-around sidebar_label: 002 - Poking around title: 002 - Poking around +description: Exploring the default frontend plugin structure and components --- Our frontend TODO plugin is a bit more simplistic than the backend one. We need to implement a new UI to replace the example components we have. diff --git a/docs/golden-path/plugins/frontend/003-dynamic-config.md b/docs/golden-path/plugins/frontend/003-dynamic-config.md index 8eecd72c2f..8f3b7ff1ef 100644 --- a/docs/golden-path/plugins/frontend/003-dynamic-config.md +++ b/docs/golden-path/plugins/frontend/003-dynamic-config.md @@ -2,6 +2,7 @@ id: dynamic-config sidebar_label: 003 - Dynamic Config title: 003 - Dynamic Config +description: How to use dynamic configuration to control frontend plugin components --- Your plugin should have been generated by default for the New Frontend System which is config-first. That means you can easily control your frontend components through your `app-config.yaml`. diff --git a/docs/golden-path/plugins/frontend/004-http-client.md b/docs/golden-path/plugins/frontend/004-http-client.md index b6190f0f5f..00678df1d6 100644 --- a/docs/golden-path/plugins/frontend/004-http-client.md +++ b/docs/golden-path/plugins/frontend/004-http-client.md @@ -2,6 +2,7 @@ id: http-client sidebar_label: 004 - HTTP Client title: 004 - HTTP Client +description: How to build an HTTP client for your frontend plugin to fetch backend data --- Now, let's really make our page dynamic. We'll start by writing an HTTP client by hand. diff --git a/docs/golden-path/plugins/frontend/005-testing.md b/docs/golden-path/plugins/frontend/005-testing.md index fe385d7169..6a672998aa 100644 --- a/docs/golden-path/plugins/frontend/005-testing.md +++ b/docs/golden-path/plugins/frontend/005-testing.md @@ -2,6 +2,7 @@ id: testing sidebar_label: 005 - Testing title: 005 - Testing +description: How to write tests for your Backstage frontend plugin components --- Everyone's favorite part! Let's make sure our components continue to work even when we're not able to validate the changes. diff --git a/docs/golden-path/plugins/index.md b/docs/golden-path/plugins/index.md index 616c2c0c36..43ffe612e8 100644 --- a/docs/golden-path/plugins/index.md +++ b/docs/golden-path/plugins/index.md @@ -2,6 +2,7 @@ id: index sidebar_label: Backstage Plugins! title: How to create plugins with Backstage +description: A guided walkthrough for building frontend and backend plugins in Backstage --- ### Prerequisites diff --git a/docs/golden-path/plugins/integrations/001-catalog.md b/docs/golden-path/plugins/integrations/001-catalog.md index f5ed04116e..4825a08ca8 100644 --- a/docs/golden-path/plugins/integrations/001-catalog.md +++ b/docs/golden-path/plugins/integrations/001-catalog.md @@ -2,6 +2,7 @@ id: catalog sidebar_label: 001 - Catalog title: Integrating with Catalog +description: How to integrate your plugin with the Backstage Software Catalog --- ## Software Catalog diff --git a/docs/golden-path/plugins/integrations/002-search.md b/docs/golden-path/plugins/integrations/002-search.md index b0ef762f27..b3d23de4d9 100644 --- a/docs/golden-path/plugins/integrations/002-search.md +++ b/docs/golden-path/plugins/integrations/002-search.md @@ -2,6 +2,7 @@ id: search sidebar_label: 002 - Search title: Integrating with Search +description: How to integrate your plugin with Backstage Search --- ## Search diff --git a/docs/golden-path/plugins/integrations/003-permissions.md b/docs/golden-path/plugins/integrations/003-permissions.md index 167d40d47f..642133eef3 100644 --- a/docs/golden-path/plugins/integrations/003-permissions.md +++ b/docs/golden-path/plugins/integrations/003-permissions.md @@ -2,6 +2,7 @@ id: permissions sidebar_label: 003 - Permissions title: Integrating with the Permission framework +description: How to integrate your plugin with the Backstage Permission framework --- ## Permissions diff --git a/docs/golden-path/plugins/integrations/004-notifications.md b/docs/golden-path/plugins/integrations/004-notifications.md index 23c44b4721..d28f08da49 100644 --- a/docs/golden-path/plugins/integrations/004-notifications.md +++ b/docs/golden-path/plugins/integrations/004-notifications.md @@ -2,6 +2,7 @@ id: notifications sidebar_label: 004 - Notifications title: Integrating with Notifications +description: How to integrate your plugin with Backstage Notifications --- ## Notifications diff --git a/docs/golden-path/plugins/sustainable-plugin-development.md b/docs/golden-path/plugins/sustainable-plugin-development.md index 82d529d6e1..4f2753fbb7 100644 --- a/docs/golden-path/plugins/sustainable-plugin-development.md +++ b/docs/golden-path/plugins/sustainable-plugin-development.md @@ -2,6 +2,7 @@ id: sustainable-plugin-development sidebar_label: Sustainable plugin development title: Sustainably developing plugins in Backstage +description: Best practices for maintaining and iterating on Backstage plugins long-term --- Plugins are not created in a vacuum, they generally solve a customer ask, be that diff --git a/docs/golden-path/plugins/why-build-plugins.md b/docs/golden-path/plugins/why-build-plugins.md index b0e1be0a98..36a74158c2 100644 --- a/docs/golden-path/plugins/why-build-plugins.md +++ b/docs/golden-path/plugins/why-build-plugins.md @@ -2,6 +2,7 @@ id: why-build-plugins sidebar_label: Why build plugins? title: Introduction to the Value and Impact of Plugins within Backstage +description: Understanding the benefits and impact of building plugins for Backstage --- Backstage plugins are essential components that enable the integration of various tools and services into a unified developer portal. Here’s a detailed look at why building plugins for Backstage can be highly beneficial: diff --git a/docs/tutorials/quickstart-app-plugin.md b/docs/tutorials/quickstart-app-plugin.md index 1f460173cd..b42a22f63b 100644 --- a/docs/tutorials/quickstart-app-plugin.md +++ b/docs/tutorials/quickstart-app-plugin.md @@ -1,6 +1,7 @@ --- id: quickstart-app-plugin title: Adding Custom Plugin to Existing Monorepo App +description: Tutorial for adding a custom plugin to an existing Backstage monorepo application --- ###### September 15th 2020 - v0.1.1-alpha.21