address pr feedback

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-10-19 13:23:01 -04:00
parent 7b95f3bd21
commit d286919ef8
3 changed files with 72 additions and 57 deletions
@@ -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!