paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 20 Packages Projects Releases Wiki Activity

Addressing review for the headings. Removed numbers and used descriptive words.

Browse Source 
Signed-off-by: markyjacksonfishing <marky.r.jackson@gmail.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
markyjacksonfishing
2024-08-17 07:02:34 -07:00
committed by aramissennyeydd
parent d808754446
commit d3a1de9e30
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/index.md
+11 -11
View File
@@ -1,7 +1,9 @@
---
id: index
title: Introduction to Plugins
description: 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.
@@ -16,9 +18,7 @@ Embark on your plugin development journey by following the detailed steps provid
## Suggesting a Plugin
If you're developing an open-source plugin, we encourage you to create a
[new issue in the community plugins repository](https://github.com/backstage/community-plugins/issues/new/choose).
This informs the community about upcoming plugins and invites collaboration and feedback.
If you're developing an open-source plugin, we encourage you to create a [new issue in the community plugins repository](https://github.com/backstage/community-plugins/issues/new/choose). 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.
@@ -28,29 +28,29 @@ Should your plugin complement the Software Catalog rather than exist as a standa
## Guides for Plugin Development
### For Beginners: Building Your First Plugin
### 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.
- **Plugins 101: Building Your First Plugin**
- **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 Your Plugin
### 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.
- **Plugins 201: Bringing Your Plugin to Production**
- **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: Deep Dive into Plugin Development
### For Advanced Users: Advanced Plugin Customization and Integration
This is for those ready to explore complex challenges and enhance their plugins with advanced features.
- **Plugins 301: Advanced Topics in Plugin Development**
- **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.
@@ -58,12 +58,10 @@ This is for those ready to explore complex challenges and enhance their plugins
## 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.
@@ -71,3 +69,5 @@ This is for those ready to explore complex challenges and enhance their plugins
- 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!
---