address pr feedback
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
aramissennyeydd
@@ -0,0 +1,58 @@
|
||||
---
|
||||
id: guides
|
||||
title: Guides for Plugins
|
||||
meta:
|
||||
status: in-progress
|
||||
---
|
||||
|
||||
## 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.
|
||||
- Open-sourcing: How and when to contribute back to the community.
|
||||
|
||||
## Additional Resources and Further Reading
|
||||
|
||||
- **Real-world Implementations and Lessons**
|
||||
|
||||
- [Case studies and examples from the community](https://github.com/backstage/community#newsletters).
|
||||
- Best practices derived from mature implementations.
|
||||
- [Existing open-source community-maintained plugins](https://github.com/backstage/community-plugins).
|
||||
|
||||
- **Resource Compendium**
|
||||
|
||||
- [Backstage Glossary](https://backstage.io/docs/references/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!
|
||||
@@ -24,54 +24,4 @@ This approach is equally beneficial if you conceive an idea for a potentially im
|
||||
|
||||
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](integrating-plugin-into-software-catalog.md).
|
||||
|
||||
## 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](https://backstage.io/docs/references/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!
|
||||
|
||||
---
|
||||
|
||||
+14
-7
@@ -1,28 +1,35 @@
|
||||
---
|
||||
id: why-build-plugins
|
||||
title: Why build plugins?
|
||||
meta:
|
||||
status: in-progress
|
||||
---
|
||||
|
||||
# Why Build Plugins? Introduction to the Value and Impact of Plugins within 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:
|
||||
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 how and why building plugins for Backstage can be highly beneficial:
|
||||
|
||||
## Enhancing Developer Productivity
|
||||
## 1. Enhancing Developer Productivity
|
||||
|
||||
Plugins in Backstage centralize and simplify access to tools, reducing the time developers spend switching between different systems. By providing a consistent interface and user experience, plugins minimize cognitive load and streamline workflows, allowing developers to focus more on coding and less on tool management. Plugins can leverage platform APIs and reusable UI components to integrate external data and services seamlessly.
|
||||
|
||||
## Customizable and Extensible Platform
|
||||
## 2. Customizable and Extensible Platform
|
||||
|
||||
Backstage's plugin architecture is designed to be highly flexible, enabling the integration of nearly any infrastructure or software development tool. This extensibility allows organizations to tailor Backstage to meet their specific needs, integrating internal tools, third-party services, and other custom functionalities seamlessly. For detailed guidelines on plugin development, refer to the [Backstage Plugin Development documentation](https://backstage.io/docs/plugins/plugin-development/).
|
||||
|
||||
## Improved Collaboration and Knowledge Sharing
|
||||
## 3. Improved Collaboration and Knowledge Sharing
|
||||
|
||||
Plugins facilitate better collaboration among teams by consolidating documentation, code repositories, CI/CD pipelines, and monitoring tools in one place. This centralization makes it easier for team members to find information, share insights, and collaborate on projects, enhancing overall team productivity and coherence.
|
||||
|
||||
## Consistency and Best Practices
|
||||
## 4. Consistency and Best Practices
|
||||
|
||||
By adhering to Backstage’s design guidelines, plugins ensure a consistent user experience across the platform. This consistency helps in maintaining usability and reducing the learning curve for new users, promoting the adoption of best practices within development teams. More details can be found in the [Introduction to Plugins](https://backstage.io/docs/plugins/) section.
|
||||
|
||||
## Scalability and Maintenance
|
||||
## 5. Scalability and Maintenance
|
||||
|
||||
Backstage plugins are designed to be modular and independent, allowing for easy updates and maintenance without affecting the overall system. This modularity supports horizontal scalability, where each plugin can be scaled independently according to the needs of the application, ensuring robust performance and reliability. For more on structuring and connecting plugins, see the [Structure of a Plugin](https://backstage.io/docs/plugins/structure-of-a-plugin) documentation.
|
||||
|
||||
## Community and Ecosystem Growth
|
||||
## 6. Community and Ecosystem Growth
|
||||
|
||||
Developing and contributing plugins to the Backstage community helps in expanding the ecosystem. Open-source contributions foster innovation and collaboration, allowing developers to leverage a wide range of existing plugins and avoid reinventing the wheel. This collaborative environment accelerates the development of new features and enhances the overall value of the Backstage platform.
|
||||
|
||||
Reference in New Issue
Block a user