diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md index 8c1733a6a6..4c91b755ee 100644 --- a/.github/ISSUE_TEMPLATE/bug_template.md +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -1,35 +1,43 @@ --- name: 'Bug Report' about: 'Create Bug Report' +labels: bug --- ## Expected Behavior + ## Current Behavior + ## Possible Solution + -## Steps to Reproduce (for bugs) +## Steps to Reproduce + -1. -2. -3. -4. + +1. Step 1 +2. Step 2 +3. ... ## Context + ## Your Environment + -* NodeJS Version (v12): -* Operating System and Version (e.g. Ubuntu 14.04): -* Browser Information: \ No newline at end of file + +- NodeJS Version (v12): +- Operating System and Version (e.g. Ubuntu 14.04): +- Browser Information: diff --git a/.github/ISSUE_TEMPLATE/feature_template.md b/.github/ISSUE_TEMPLATE/feature_template.md index 17b543c27a..012b8d7a06 100644 --- a/.github/ISSUE_TEMPLATE/feature_template.md +++ b/.github/ISSUE_TEMPLATE/feature_template.md @@ -1,18 +1,22 @@ --- name: 'Feature Request' about: 'Suggest new features and changes' +labels: help wanted --- ## Feature Suggestion + ## Possible Implementation + ## Context + - \ No newline at end of file + diff --git a/.github/ISSUE_TEMPLATE/plugin_template.md b/.github/ISSUE_TEMPLATE/plugin_template.md new file mode 100644 index 0000000000..75f0828848 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/plugin_template.md @@ -0,0 +1,21 @@ +--- +name: 'Plugin suggestion' +about: 'Suggest a new Backstage plugin' +title: '[Plugin] THE PLUGIN NAME' +labels: plugin +--- + + + + +## Summary + + + +## Project website (if applicable) + + + +## Context + + diff --git a/.github/ISSUE_TEMPLATE/ux-component_template.md b/.github/ISSUE_TEMPLATE/ux-component_template.md index 217d0c89ee..95b8f47615 100644 --- a/.github/ISSUE_TEMPLATE/ux-component_template.md +++ b/.github/ISSUE_TEMPLATE/ux-component_template.md @@ -1,23 +1,23 @@ --- name: 'UX Component' about: 'For designers to request UX components to be added to the Backstage Storybook' +labels: design --- ## 🗒 General + ## 💻 Usage + ## 📐 Specs + ## 🔮 Future - -- -- -- -- -- + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68fb208caa..e07c18e024 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 4034951656..55a4b5d5da 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/getting-started/my-plugin_screenshot.png b/docs/getting-started/my-plugin_screenshot.png index f12efe54fe..0b2817fa1e 100644 Binary files a/docs/getting-started/my-plugin_screenshot.png and b/docs/getting-started/my-plugin_screenshot.png differ diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 0000000000..7fe6a7312d --- /dev/null +++ b/plugins/README.md @@ -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.