Document how to suggest new plugins (#590)

* Document how to suggest new plugins

* Update plugin_template.md

* Update ux-component_template.md

* Update plugin_template.md
This commit is contained in:
Stefan Ålund
2020-04-18 18:00:15 +02:00
committed by GitHub
parent 8e5592c6e8
commit 151417a9ed
8 changed files with 73 additions and 17 deletions
+16 -8
View File
@@ -1,35 +1,43 @@
---
name: 'Bug Report'
about: 'Create Bug Report'
labels: bug
---
<!--- Provide a general summary of the issue in the Title above -->
## Expected Behavior
<!--- Tell us what should happen -->
## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas as to the implementation of the addition or change -->
## Steps to Reproduce (for bugs)
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code or configuration to reproduce, if relevant -->
1.
2.
3.
4.
1. Step 1
2. Step 2
3. ...
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context (e.g. links to configuration settings, -->
<!--- stack trace or log data) helps us come up with a solution that is most useful in the real world -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* NodeJS Version (v12):
* Operating System and Version (e.g. Ubuntu 14.04):
* Browser Information:
- NodeJS Version (v12):
- Operating System and Version (e.g. Ubuntu 14.04):
- Browser Information:
+5 -1
View File
@@ -1,18 +1,22 @@
---
name: 'Feature Request'
about: 'Suggest new features and changes'
labels: help wanted
---
<!--- Provide a general summary of the feature request in the Title above -->
## Feature Suggestion
<!--- If you're looking for help, please see https://backstage.io/ --->
<!--- Tell us how we could improve your experience -->
## Possible Implementation
<!--- Not obligatory, but ideas as to the implementation of the addition or change -->
## Context
<!--- What are you trying to accomplish? -->
<!--- Providing context (e.g. links to configuration settings, stack trace or log data) -->
<!--- helps us come up with a solution that is most useful in the real world -->
<!--- helps us come up with a solution that is most useful in the real world -->
+21
View File
@@ -0,0 +1,21 @@
---
name: 'Plugin suggestion'
about: 'Suggest a new Backstage plugin'
title: '[Plugin] THE PLUGIN NAME'
labels: plugin
---
<!--- Thanks for suggesting a new plugin! -->
<!--- If you plan to work on this plugin, please Assign yourself or your team member(s) -->
## Summary
<!--- Provide a general summary of the plugin and how it should work -->
## Project website (if applicable)
<!--- Add a link to the open source project or product this plugin will integrate with, if existing -->
## Context
<!--- Providing additional context -->
@@ -1,23 +1,23 @@
---
name: 'UX Component'
about: 'For designers to request UX components to be added to the Backstage Storybook'
labels: design
---
## 🗒 General
<!--- Write a nice note to the community requesting the creation of a new component! -->
<!--- Include an image of your component. Bonus points for a GIF! -->
## 💻 Usage
<!--- Tell us what the point of this component/pattern is! How does it help? How should it work? Any rules? -->
## 📐 Specs
<!--- Include images that detail the redlines for your component.-->
<!--- Once we get our Figma workspace set up, we'll be posting the Figma files rather than doing specs by hand.-->
## 🔮 Future
<!--- Any upcoming, exciting functionality for this component in the future? List that out here. -->
-
-
-
-
-
<!-- Any upcoming, exciting functionality for this component in the future? List that out here. -->
+7 -1
View File
@@ -20,9 +20,15 @@ Look through the GitHub issues for [bugs](https://github.com/spotify/backstage/l
The value of Backstage grows with every new plugin that gets added. Wouldn't it be fantastic if there was a plugin for every infrastructure project out there? We think so. And we would love your help.
A great reference example of a plugin can be found on [our blog](https://backstage.io/blog/2020/04/06/lighthouse-plugin) (thanks [@fastfrwrd](https://github.com/fastfrwrd)!)
What kind of plugins should/could be created? Some inspiration from the 120+ plugins that we have developed inside Spotify can be found [here](https://backstage.io/demos), but we will keep a running list of suggestions labeled with [[plugin]](https://github.com/spotify/backstage/labels/plugin).
A great reference example of a plugin can be found on [our blog](https://backstage.io/blog/2020/04/06/lighthouse-plugin) (thanks [@fastfrwrd](https://github.com/fastfrwrd)!)
## Suggesting a plugin
If you start developing a plugin that you aim to release as open source, we suggest that you create a new [new Issue](https://github.com/spotify/backstage/issues/new?template=plugin_template.md). This helps the community know what plugins are in development.
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.
## Write Documentation
+1 -1
View File
@@ -43,7 +43,7 @@ Our vision for Backstage is for it to become the trusted standard toolbox (read:
The Backstage platform consists of a number of different components:
- **app** - Main web application that users interact with. It's built up by a number of different _Plugins_. This repo contains an example implementation of an app (located in `packages/example-app`) and you can easily get started with your own app by [creating one](docs/create-an-app.md).
- **plugins** - Each plugin is treated as a self-contained web app and can include almost any type of content. Plugins all use a common set of platform API's and reusable UI components. Plugins can fetch data either from the _backend_ or through any RESTful API exposed through the _proxy_.
- [**plugins**](https://github.com/spotify/backstage/tree/master/plugins) - Each plugin is treated as a self-contained web app and can include almost any type of content. Plugins all use a common set of platform API's and reusable UI components. Plugins can fetch data either from the _backend_ or through any RESTful API exposed through the _proxy_.
- **backend** \* - GraphQL aggregation service that holds the model of your software ecosystem, including organisational information and what team owns what software. The backend also has a Plugin model for extending its graph.
- **proxy** \* - Terminates HTTPS and exposes any RESTful API to Plugins.
- **identity** \* - A backend service that holds your organisation's metadata.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 349 KiB

After

Width:  |  Height:  |  Size: 389 KiB

+17
View File
@@ -0,0 +1,17 @@
# Plugins
Backstage is a single-page application composed of a 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](https://github.com/spotify/backstage/blob/master/docs/design.md) we ensure the the overall user experience stays consistent between plugins.
![plugin](../docs/getting-started/my-plugin_screenshot.png)
## Creating a plugin
To create a plugin, follow the steps outlined [here](https://github.com/spotify/backstage/blob/master/docs/getting-started/create-a-plugin.md).
## Suggesting a plugin
If you start developing a plugin that you aim to release as open source, we suggest that you create a new [new Issue](https://github.com/spotify/backstage/issues/new?template=plugin_template.md). This helps the community know what plugins are in development.
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.