backstage/docs/plugins/index.md

id, title, description

id	title	description
index	Introduction to Plugins	Learn about integrating various infrastructure and software development tools into Backstage through plugins.

Backstage orchestrates a cohesive single-page application by seamlessly integrating various 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 guarantees a consistent and intuitive user experience across the entire plugin landscape.

Creating a Plugin

Embark on your plugin development journey by following the detailed steps provided in the Create a Plugin documentation.

Suggesting a Plugin

If you're developing an open-source plugin, we encourage you to create a new issue in the community plugins repository. This informs the community about upcoming plugins and invites collaboration and feedback.

This approach is equally beneficial if you conceive an idea for a potentially impactful plugin but prefer if another contributor undertakes its development.

Integration with the Software Catalog

Should your plugin complement the Software Catalog rather than exist as a standalone feature (for instance, as an additional tab or a card within an "Overview" tab), you'll find comprehensive guidance on achieving this integration in the Integrating Plugin into Software Catalog guide.

Guides for Plugin Development

:::note Note This section is still a work in progress, many of the guides described below do not exist yet. :::

For Beginners: Introduction to Plugin Development

This section is designed for those new to plugin development. It covers the basics and provides a foundation for more advanced topics.

• Introduction to Plugin Development
  • Why build plugins? Introduction to the value and impact of plugins within Backstage.
  • Detailed guidance on starting and iterating on a plugin development project.
  • Engaging with the community and stakeholders to propel your project.

For Intermediate Users: Scaling and Deploying Your Plugin

This section helps developers prepare their plugins for broader adoption, emphasizing best practices in monitoring, logging, and performance.

• Scaling and Deploying Your Plugin
  • Strategies for scaling your plugin for greater adoption.
  • Best practices for monitoring and logging.
  • Understand plugin ownership and maintain an inner source mentality.

For Advanced Users: Advanced Plugin Customization and Integration

This is for those ready to explore complex challenges and enhance their plugins with advanced features.

• Advanced Plugin Customization and Integration
  • Enabling resource-level authorization and interfacing with external services, SCMs, or databases.
  • In-depth exploration of fostering an inner source mentality and understanding adoption dynamics.
  • Decision-making frameworks: choosing between developing a new plugin or utilizing an existing open-source solution.

Additional Resources and Further Reading

• Real-world Implementations and Lessons

  • Case studies and examples from the community.
  • Best practices derived from mature implementations.

• Resource Compendium

  • Backstage Glossary of key terms.
  • Recommended readings and tools for advanced developers.

• Certification and Learning Pathways

  • Pathways to deepen your understanding and expertise in plugin development for Backstage.

Stay tuned for detailed exploration and guidance in each of these modules. We're excited to accompany you on your plugin development journey!

---