diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 94de3bc482..4848a0a96f 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -1,36 +1,25 @@ --- id: index -title: Intro to plugins -description: Documentation on Introduction to Plugins +title: Introduction to Plugins +description: Learn about integrating various infrastructure and software development tools into Backstage through plugins. --- -Backstage is a single-page application composed of a set of plugins. +Backstage orchestrates a cohesive single-page application by seamlessly integrating a diverse set of plugins. -Our goal for the plugin ecosystem is that the definition of a plugin is flexible -enough to allow you to expose pretty much any kind of infrastructure or software -development tool as a plugin in Backstage. By following strong -[design guidelines](../dls/design.md) we ensure the overall user experience -stays consistent between plugins. +Our vision for the plugin ecosystem champions flexibility, empowering you to incorporate a broad spectrum of infrastructure and software development tools into Backstage as plugins. Adherence to stringent [design guidelines](../dls/design.md) guarantees a consistent and intuitive user experience across the entire plugin landscape. -![plugin](../assets/plugins/my-plugin_screenshot.png) +![Plugin Screenshot](../assets/plugins/my-plugin_screenshot.png) -## Creating a plugin +## Creating a Plugin -To create a plugin, follow the steps outlined [here](create-a-plugin.md). +Embark on your plugin development journey by following the detailed steps provided [here](create-a-plugin.md). -## Suggesting a plugin +## Suggesting a Plugin -If you start developing a plugin that you aim to release as open source, we -suggest that you create a -[new Issue in the community plugins repo](https://github.com/backstage/community-plugins/issues/new/choose). -This helps the community know what plugins are in development. +If you're developing an open-source plugin, we encourage you to initiate a [new Issue in the community plugins repo](https://github.com/backstage/community-plugins/issues/new/choose). This gesture not only informs the community about upcoming plugins but also invites collaboration and feedback. -You can also use this process if you have an idea for a good plugin but you hope -that someone else will pick up the work. +This approach is equally beneficial if you conceive an idea for a potentially impactful plugin but prefer if another contributor undertakes its development. -## Integrate into the Software Catalog +## Integration with the Software Catalog -If your plugin isn't supposed to live as a standalone page, but rather needs to -be presented as a part of a Software Catalog (e.g. a separate tab or a card on -an "Overview" tab), then check out -[the instruction](integrating-plugin-into-software-catalog.md) on how to do it. +Should your plugin complement the Software Catalog rather than exist as a standalone entity (for instance, as an additional tab or a card within an "Overview" tab), you'll find comprehensive guidance on achieving this integration [here](integrating-plugin-into-software-catalog.md).