docs: add missing description frontmatter to golden-path docs
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com>
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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`.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
id: search
|
||||
sidebar_label: 002 - Search
|
||||
title: Integrating with Search
|
||||
description: How to integrate your plugin with Backstage Search
|
||||
---
|
||||
|
||||
## Search
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
id: notifications
|
||||
sidebar_label: 004 - Notifications
|
||||
title: Integrating with Notifications
|
||||
description: How to integrate your plugin with Backstage Notifications
|
||||
---
|
||||
|
||||
## Notifications
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user