From 8c1662fbf9914b831cfd316f436f6dc878b6efbc Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Thu, 12 Nov 2020 00:14:22 +0100
Subject: [PATCH 1/7] docs: add stability index

Co-authored-by: blam <ben@blam.sh>
---
 docs/overview/stability-index.md | 470 +++++++++++++++++++++++++++++++
 microsite/sidebars.json          |   1 +
 2 files changed, 471 insertions(+)
 create mode 100644 docs/overview/stability-index.md

diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
new file mode 100644
index 0000000000..1ca54f150a
--- /dev/null
+++ b/docs/overview/stability-index.md
@@ -0,0 +1,470 @@
+---
+id: stability-index
+title: Stability Index
+description:
+  An overview of the commitment to stability for different parts of the
+  Backstage codebase.
+---
+
+## Overview
+
+The purpose of the Backstage Stability Index is to communicate the stability of
+various parts of the project. It is tracked using a scoring system where a
+higher score indicates a higher level of stability and is a commitment to
+smoother transitions between breaking changes. Importantly, the Stability Index
+does not supersede [semver](https://semver.org/), meaning we will still adhere
+to semver and only do breaking changes in minor releases as long as we are on
+`0.x`.
+
+Each package or section is assigned a stability score between 0 and 3, with each
+point building on top of the previous one:
+
+- **0** - Breaking changes are noted in the changelog, and documentation is
+  updated.
+- **1** - The changelog entry includes a clearly documented upgrade path,
+  providing guidance for how to migrate previous usage patterns to the new
+  version.
+- **2** - Breaking changes always include a deprecation phase where both the old
+  and the new APIs can be used in parallel. This deprecation must have been
+  released for at least two weeks before the deprecated API is removed in a
+  minor version bump.
+- **3** - The time limit for the deprecation is 3 months instead of two weeks.
+
+TL;DR:
+
+- **0** - There's a changelog entry.
+- **1** - There's a migration guide.
+- **2** - 2 weeks of deprecation.
+- **3** - 3 months of deprecation.
+
+## Packages
+
+### [example-app](https://github.com/backstage/backstage/tree/master/packages/app/)
+
+This is the `packages/app` package, and it's serves as an example as well as
+utility for local development in the main Backstage repo.
+
+Stability: `N/A`
+
+### [example-backend](https://github.com/backstage/backstage/tree/master/packages/backend/)
+
+This is the `packages/backend` package, and it's serves as an example as well as
+utility for local development in the main Backstage repo.
+
+Stability: `N/A`
+
+### [backend-common](https://github.com/backstage/backstage/tree/master/packages/backend-common/)
+
+A collection of common helpers to be used by both backend plugins, and for
+constructing backend packages.
+
+Stability: `1`
+
+### [catalog-client](https://github.com/backstage/backstage/tree/master/packages/catalog-client/)
+
+An HTTP client for interacting with the catalog backend. Usable both in frontend
+and Backend.
+
+Stability: `0`. This is a very new addition and we have some immediate changes
+planned.
+
+### [catalog-model](https://github.com/backstage/backstage/tree/master/packages/catalog-model/)
+
+Contains the core catalog model, and utilities for working with entities. Usable
+both in frontend and Backend.
+
+Stability: `2`. The catalog model is evolving, but because of the broad usage we
+
+want to ensure some stability.
+
+### [cli](https://github.com/backstage/backstage/tree/master/packages/cli/)
+
+The main toolchain used for Backstage development. The interface that is
+considered for stability are the various commands and options passed to those
+commands, as well as the environment variables read by the CLI. The build output
+may change over time and is not considered a breaking change unless it is likely
+to affect external tooling.
+
+Stability: `2`
+
+### [cli-common](https://github.com/backstage/backstage/tree/master/packages/cli-common/)
+
+Lightweight utilities used by the various Backstage CLIs, not intended for
+external use.
+
+Stability: `N/A`
+
+### [config](https://github.com/backstage/backstage/tree/master/packages/config/)
+
+Provides the logic and interfaces for reading static configuration.
+
+Stability: `2`
+
+### [config-loader](https://github.com/backstage/backstage/tree/master/packages/config-loader/)
+
+Used to load in static configuration, mainly for use by the CLI and
+@backstage/backend-common.
+
+Stability: `1`. Mainly intended for internal use.
+
+### [core](https://github.com/backstage/backstage/tree/master/packages/core/)
+
+#### Section: React Components
+
+All of the React components exported from `src/components/` and `src/layout/`
+
+Stability: `1`. These components have not received a proper review of the API,
+but we also want to ensure stability.
+
+#### Section: Plugin API
+
+The parts of the core API that are used by plugins, and the way plugins expose
+functionality to apps and other plugins. Includes for example `createPlugin`,
+`createRouteRef`, `createApiRef`.
+
+Stability: `2`. There are planned breaking changes around the way that plugins
+expose features and do routing. We still commit to keeping a short deprecation
+period so that plugins outside of the main repo have time to migrate.
+
+#### Section: App API
+
+The APIs used exclusively in the app, such as `createApp` and the system icons.
+
+Stability: `2`
+
+#### Section: Utility API Definitions
+
+The type declarations of the core Utility APIs.
+
+Stability: `2`. Changes to the Utility API type declarations need time to
+propagate.
+
+#### Section: Utility API Implementations
+
+The interfaces and default implementations for various Utility APIs, such as
+ErrorApi, IdentityApi, the auth APIs, etc.
+
+Stability: `1`. Most changes to the core utility APIs will not lead to
+widespread breaking changes since most apps rely on the default implementations.
+
+### [core-api](https://github.com/backstage/backstage/tree/master/packages/core-api/)
+
+The non-visual parts of @backstage/core. Everything in this packages is
+re-exported from @backstage/core, and this package should not be used directly.
+
+Stability: See @backstage/core
+
+### [create-app](https://github.com/backstage/backstage/tree/master/packages/create-app/)
+
+The CLI used to scaffold new Backstage projects.
+
+Stability: `2`
+
+### [dev-utils](https://github.com/backstage/backstage/tree/master/packages/dev-utils/)
+
+Provides utilities for developing plugins in isolation.
+
+Stability: `0`. This package is largely broken and needs updates.
+
+### [docgen](https://github.com/backstage/backstage/tree/master/packages/docgen/)
+
+Internal CLI utility for generating API Documentation.
+
+Stability: `N/A`
+
+### [e2e-test](https://github.com/backstage/backstage/tree/master/packages/e2e-test/)
+
+Internal CLI utility for running e2e tests.
+
+Stability: `N/A`
+
+### [storybook](https://github.com/backstage/backstage/tree/master/packages/storybook/)
+
+Internal storybook build for publishing stories to
+https://backstage.io/storybook
+
+Stability: `N/A`
+
+### [test-utils](https://github.com/backstage/backstage/tree/master/packages/test-utils/)
+
+Utilities for writing tests for Backstage plugins and apps.
+
+Stability: `2`
+
+### [test-utils-core](https://github.com/backstage/backstage/tree/master/packages/test-utils-core/)
+
+Internal testing utilities that are separated out for usage in
+@backstage/core-api. All exports are re-exported by @backstage/test-utils. This
+package should not be depended on directly.
+
+Stability: See @backstage/test-utils
+
+### [theme](https://github.com/backstage/backstage/tree/master/packages/theme/)
+
+The core Backstage MUI theme along with customization utilities.
+
+#### Section: TypeScript
+
+This is the TypeScript API exported by the theme package.
+
+Stability: `2`
+
+#### Section: Visual Theme
+
+The visual theme exported by the theme packages, where for example changing a
+color could be considered a breaking change.
+
+Stability: `1`
+
+## Plugins
+
+Plugins are rarely marked as stable as the `@backstage/core` plugin API is under
+heavy development.
+
+Many backend plugins are split into "REST API" and "TypeScript Interface"
+sections. The "TypeScript Interface" refers to the API used to integrate the
+plugin into the backend.
+
+### [api-docs](https://github.com/backstage/backstage/tree/master/plugins/api-docs/)
+
+Components to discover and display API entities as an extension to the catalog
+plugin.
+
+Stability: `0`
+
+### [app-backend](https://github.com/backstage/backstage/tree/master/plugins/app-backend/)
+
+A backend plugin that can be used to serve the frontend app and inject
+configuration.
+
+Stability: `2`
+
+### [auth-backend](https://github.com/backstage/backstage/tree/master/plugins/auth-backend/)
+
+A backend plugin that implements the backend portion of the various
+authentication flows used in Backstage.
+
+#### Section: REST API
+
+Stability: `2`
+
+#### Section: TypeScript Interface
+
+Stability: `1`
+
+### [catalog](https://github.com/backstage/backstage/tree/master/plugins/catalog/)
+
+The frontend plugin for the catalog, with the table and building blocks for the
+entity pages.
+
+Stability: `1`. We're planning some work to overhaul how entity pages are
+constructed.
+
+### [catalog-backend](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend/)
+
+The backend API for the catalog, also exposes the processing subsystem for
+customization of the catalog. Powers the @backstage/plugin-catalog frontend
+plugin.
+
+#### Section: REST API
+
+Stability: `1`. There are plans to remove and rework some endpoints.
+
+#### Section: TypeScript Interface
+
+Stability: `1`. There are plans to rework parts of the Processor interface.
+
+### [catalog-graphql](https://github.com/backstage/backstage/tree/master/plugins/catalog-graphql/)
+
+Provides the catalog schema and resolvers for the graphql backend.
+
+Stability: `0`. Under heavy development and subject to change.
+
+### [circleci](https://github.com/backstage/backstage/tree/master/plugins/circleci/)
+
+Automate your development process with CI hosted in the cloud or on a private
+server.
+
+Stability: `0`
+
+### [cloudbuild](https://github.com/backstage/backstage/tree/master/plugins/cloudbuild/)
+
+Visualize Google Cloud Build flows.
+
+Stability: `0`
+
+### [cost-insights](https://github.com/backstage/backstage/tree/master/plugins/cost-insights/)
+
+Visualize, understand and optimize your team's cloud costs.
+
+Stability: `0`
+
+### [explore](https://github.com/backstage/backstage/tree/master/plugins/explore/)
+
+A frontend plugin that introduces the concept of exploring internal and external
+tooling in an organization.
+
+Stability: `0`. Only an example at the moment and not customizable.
+
+### [gcp-projects](https://github.com/backstage/backstage/tree/master/plugins/gcp-projects/)
+
+Create, list and manage your Google Cloud Projects.
+
+Stability: `0`
+
+### [github-actions](https://github.com/backstage/backstage/tree/master/plugins/github-actions/)
+
+GitHub Actions makes it easy to automate all your software workflows, now with
+world-class CI/CD. Build, test, and deploy your code right from GitHub.
+
+Stability: `0`
+
+### [gitops-profiles](https://github.com/backstage/backstage/tree/master/plugins/gitops-profiles/)
+
+A frontend plugin with a separate backend that can be used to provision EKS
+clusters.
+
+Stability: `0`. This is an early plugin that now has quite a lot of overlap with
+the scaffolder plugin.
+
+### [graphiql](https://github.com/backstage/backstage/tree/master/plugins/graphiql/)
+
+Integrates GraphiQL as a tool to browse GraphQL API endpoints inside Backstage.
+
+Stability: `1`
+
+### [graphql](https://github.com/backstage/backstage/tree/master/plugins/graphql/)
+
+A backend plugin that provides
+
+Stability: `0`. Under heavy development and subject to change.
+
+### [jenkins](https://github.com/backstage/backstage/tree/master/plugins/jenkins/)
+
+A plugin that visualizes Jenkins workflows for entities. Jenkins offers a simple
+way to set up a continuous integration and continuous delivery environment.
+
+Stability: `0`
+
+### [kubernetes](https://github.com/backstage/backstage/tree/master/plugins/kubernetes/)
+
+The frontend component of the Kubernetes plugin, used to browse and visualize
+Kubernetes resources. Stability: `1`.
+
+### [kubernetes-backend](https://github.com/backstage/backstage/tree/master/plugins/kubernetes-backend/)
+
+The backend component of the Kubernetes plugin, used to fetch Kubernetes
+resources from clusters and associate them with entities in the Catalog.
+Stability: `1`.
+
+### [lighthouse](https://github.com/backstage/backstage/tree/master/plugins/lighthouse/)
+
+Google's Lighthouse tool is a great resource for benchmarking and improving the
+accessibility, performance, SEO, and best practices of your website.
+
+Stability: `0`
+
+### [newrelic](https://github.com/backstage/backstage/tree/master/plugins/newrelic/)
+
+Observability platform built to help engineers create and monitor their
+software. Stability: `0`
+
+### [proxy-backend](https://github.com/backstage/backstage/tree/master/plugins/proxy-backend/)
+
+A backend plugin used to set up proxying to other endpoints based on static
+configuration.
+
+Stability: `1`
+
+### [register-component](https://github.com/backstage/backstage/tree/master/plugins/register-component/)
+
+A frontend plugin that allows the user to register entity locations in the
+catalog.
+
+Stability: `0`. This plugin is likely to be replaced by a generic entity import
+plugin instead.
+
+### [rollbar](https://github.com/backstage/backstage/tree/master/plugins/rollbar/)
+
+The frontend component of the rollbar plugin, which can be used to view Rollbar
+errors for your services in Backstage.
+
+Stability: `0`
+
+### [rollbar-backend](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend/)
+
+The backend component of the rollbar plugin, which can be used to view Rollbar
+errors for your services in Backstage.
+
+Stability: `0`
+
+### [scaffolder](https://github.com/backstage/backstage/tree/master/plugins/scaffolder/)
+
+The frontend scaffolder plugin where one can browse templates and initiate
+scaffolding jobs.
+
+Stability: `1`
+
+### [scaffolder-backend](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/)
+
+The backend scaffolder plugin that provides an implementation for templates in
+the catalog.
+
+Stability: `1`. There is planned work to rework the scaffolder in
+https://github.com/backstage/backstage/issues/2771.
+
+### [sentry](https://github.com/backstage/backstage/tree/master/plugins/sentry/)
+
+The frontend component of the sentry plugin, which can be used to view Sentry
+issues in Backstage.
+
+Stability: `0`
+
+### [sentry-backend](https://github.com/backstage/backstage/tree/master/plugins/sentry-backend/)
+
+The backend component of the sentry plugin, which can be used to view Sentry
+issues in Backstage.
+
+Stability: `0`
+
+### [sonarqube](https://github.com/backstage/backstage/tree/master/plugins/sonarqube/)
+
+Components to display code quality metrics from SonarCloud and SonarQube.
+
+Stability: `0`
+
+### [tech-radar](https://github.com/backstage/backstage/tree/master/plugins/tech-radar/)
+
+Visualize the your company's official guidelines of different areas of software
+development.
+
+Stability: `0`
+
+### [techdocs](https://github.com/backstage/backstage/tree/master/plugins/techdocs/)
+
+The frontend component of the TechDocs plugin, used to browser technical
+documentation of entities.
+
+Stability: `1`
+
+### [techdocs-backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/)
+
+The backend component of the TechDocs plugin, used to transform and serve
+TechDocs.
+
+Stability: `1`
+
+### [user-settings](https://github.com/backstage/backstage/tree/master/plugins/user-settings/)
+
+A frontend plugin that provides a page where the user can tweak various
+settings.
+
+Stability: `1`
+
+### [welcome](https://github.com/backstage/backstage/tree/master/plugins/welcome/)
+
+A plugin that can be used to welcome the user to Backstage.
+
+Stability: `0`. This used to be the start page for the example app, but has been
+replaced by the catalog plugin. It is still viewable at `/welcome` but may be
+removed.
diff --git a/microsite/sidebars.json b/microsite/sidebars.json
index 64fdd2f420..f3cf642de1 100644
--- a/microsite/sidebars.json
+++ b/microsite/sidebars.json
@@ -7,6 +7,7 @@
       "overview/vision",
       "overview/background",
       "overview/adopting",
+      "overview/stability-index",
       "overview/logos"
     ],
     "Getting Started": [

From 148ecbfcd655193593b5cd8fe3e82f61b8f3f656 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 13 Nov 2020 13:21:42 +0100
Subject: [PATCH 2/7] github/vocab: added words

---
 .github/styles/vocab.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt
index 3c5fa34adc..efda3a185d 100644
--- a/.github/styles/vocab.txt
+++ b/.github/styles/vocab.txt
@@ -20,6 +20,7 @@ Changesets
 changset
 chanwit
 Chanwit
+circleci
 cisphobia
 cissexist
 classname
@@ -64,6 +65,7 @@ github
 Github
 gitlab
 Gitlab
+graphiql
 graphql
 graphviz
 Hackathons
@@ -80,6 +82,7 @@ inlinehilite
 interop
 javascript
 Javascript
+jenkins
 jq
 js
 json
@@ -164,9 +167,11 @@ scaffolded
 scaffolder
 Scaffolder
 semlas
+semver
 Serverless
 Sinon
 smartsymobls
+sonarqube
 sparklines
 Spotifiers
 spotify
@@ -190,6 +195,7 @@ theres
 toc
 tolerations
 Tolerations
+toolchain
 toolsets
 tooltip
 touchpoints

From a969371bf61d50c620587c176e87520e11c9574e Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 13 Nov 2020 13:51:49 +0100
Subject: [PATCH 3/7] docs/stability-index: fix a grammar

---
 docs/overview/stability-index.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
index 1ca54f150a..e410015662 100644
--- a/docs/overview/stability-index.md
+++ b/docs/overview/stability-index.md
@@ -442,7 +442,7 @@ Stability: `0`
 
 ### [techdocs](https://github.com/backstage/backstage/tree/master/plugins/techdocs/)
 
-The frontend component of the TechDocs plugin, used to browser technical
+The frontend component of the TechDocs plugin, used to browse technical
 documentation of entities.
 
 Stability: `1`

From b4c9e09b87aa29b6c9be9284682f98e09aa66d37 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Fri, 13 Nov 2020 13:54:49 +0100
Subject: [PATCH 4/7] docs/stability-index: wrap package titles in code blocks

---
 .github/styles/vocab.txt         |   4 --
 docs/overview/stability-index.md | 106 +++++++++++++++----------------
 2 files changed, 53 insertions(+), 57 deletions(-)

diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt
index efda3a185d..bd89163f1f 100644
--- a/.github/styles/vocab.txt
+++ b/.github/styles/vocab.txt
@@ -20,7 +20,6 @@ Changesets
 changset
 chanwit
 Chanwit
-circleci
 cisphobia
 cissexist
 classname
@@ -65,7 +64,6 @@ github
 Github
 gitlab
 Gitlab
-graphiql
 graphql
 graphviz
 Hackathons
@@ -82,7 +80,6 @@ inlinehilite
 interop
 javascript
 Javascript
-jenkins
 jq
 js
 json
@@ -171,7 +168,6 @@ semver
 Serverless
 Sinon
 smartsymobls
-sonarqube
 sparklines
 Spotifiers
 spotify
diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
index e410015662..96ff33542f 100644
--- a/docs/overview/stability-index.md
+++ b/docs/overview/stability-index.md
@@ -39,28 +39,28 @@ TL;DR:
 
 ## Packages
 
-### [example-app](https://github.com/backstage/backstage/tree/master/packages/app/)
+### [`example-app`](https://github.com/backstage/backstage/tree/master/packages/app/)
 
 This is the `packages/app` package, and it's serves as an example as well as
 utility for local development in the main Backstage repo.
 
 Stability: `N/A`
 
-### [example-backend](https://github.com/backstage/backstage/tree/master/packages/backend/)
+### [`example-backend`](https://github.com/backstage/backstage/tree/master/packages/backend/)
 
 This is the `packages/backend` package, and it's serves as an example as well as
 utility for local development in the main Backstage repo.
 
 Stability: `N/A`
 
-### [backend-common](https://github.com/backstage/backstage/tree/master/packages/backend-common/)
+### [`backend-common`](https://github.com/backstage/backstage/tree/master/packages/backend-common/)
 
 A collection of common helpers to be used by both backend plugins, and for
 constructing backend packages.
 
 Stability: `1`
 
-### [catalog-client](https://github.com/backstage/backstage/tree/master/packages/catalog-client/)
+### [`catalog-client`](https://github.com/backstage/backstage/tree/master/packages/catalog-client/)
 
 An HTTP client for interacting with the catalog backend. Usable both in frontend
 and Backend.
@@ -68,7 +68,7 @@ and Backend.
 Stability: `0`. This is a very new addition and we have some immediate changes
 planned.
 
-### [catalog-model](https://github.com/backstage/backstage/tree/master/packages/catalog-model/)
+### [`catalog-model`](https://github.com/backstage/backstage/tree/master/packages/catalog-model/)
 
 Contains the core catalog model, and utilities for working with entities. Usable
 both in frontend and Backend.
@@ -77,7 +77,7 @@ Stability: `2`. The catalog model is evolving, but because of the broad usage we
 
 want to ensure some stability.
 
-### [cli](https://github.com/backstage/backstage/tree/master/packages/cli/)
+### [`cli`](https://github.com/backstage/backstage/tree/master/packages/cli/)
 
 The main toolchain used for Backstage development. The interface that is
 considered for stability are the various commands and options passed to those
@@ -87,27 +87,27 @@ to affect external tooling.
 
 Stability: `2`
 
-### [cli-common](https://github.com/backstage/backstage/tree/master/packages/cli-common/)
+### [`cli-common`](https://github.com/backstage/backstage/tree/master/packages/cli-common/)
 
 Lightweight utilities used by the various Backstage CLIs, not intended for
 external use.
 
 Stability: `N/A`
 
-### [config](https://github.com/backstage/backstage/tree/master/packages/config/)
+### [`config`](https://github.com/backstage/backstage/tree/master/packages/config/)
 
 Provides the logic and interfaces for reading static configuration.
 
 Stability: `2`
 
-### [config-loader](https://github.com/backstage/backstage/tree/master/packages/config-loader/)
+### [`config-loader`](https://github.com/backstage/backstage/tree/master/packages/config-loader/)
 
 Used to load in static configuration, mainly for use by the CLI and
 @backstage/backend-common.
 
 Stability: `1`. Mainly intended for internal use.
 
-### [core](https://github.com/backstage/backstage/tree/master/packages/core/)
+### [`core`](https://github.com/backstage/backstage/tree/master/packages/core/)
 
 #### Section: React Components
 
@@ -147,51 +147,51 @@ ErrorApi, IdentityApi, the auth APIs, etc.
 Stability: `1`. Most changes to the core utility APIs will not lead to
 widespread breaking changes since most apps rely on the default implementations.
 
-### [core-api](https://github.com/backstage/backstage/tree/master/packages/core-api/)
+### [`core-api`](https://github.com/backstage/backstage/tree/master/packages/core-api/)
 
 The non-visual parts of @backstage/core. Everything in this packages is
 re-exported from @backstage/core, and this package should not be used directly.
 
 Stability: See @backstage/core
 
-### [create-app](https://github.com/backstage/backstage/tree/master/packages/create-app/)
+### [`create-app`](https://github.com/backstage/backstage/tree/master/packages/create-app/)
 
 The CLI used to scaffold new Backstage projects.
 
 Stability: `2`
 
-### [dev-utils](https://github.com/backstage/backstage/tree/master/packages/dev-utils/)
+### [`dev-utils`](https://github.com/backstage/backstage/tree/master/packages/dev-utils/)
 
 Provides utilities for developing plugins in isolation.
 
 Stability: `0`. This package is largely broken and needs updates.
 
-### [docgen](https://github.com/backstage/backstage/tree/master/packages/docgen/)
+### [`docgen`](https://github.com/backstage/backstage/tree/master/packages/docgen/)
 
 Internal CLI utility for generating API Documentation.
 
 Stability: `N/A`
 
-### [e2e-test](https://github.com/backstage/backstage/tree/master/packages/e2e-test/)
+### [`e2e-test`](https://github.com/backstage/backstage/tree/master/packages/e2e-test/)
 
 Internal CLI utility for running e2e tests.
 
 Stability: `N/A`
 
-### [storybook](https://github.com/backstage/backstage/tree/master/packages/storybook/)
+### [`storybook`](https://github.com/backstage/backstage/tree/master/packages/storybook/)
 
 Internal storybook build for publishing stories to
 https://backstage.io/storybook
 
 Stability: `N/A`
 
-### [test-utils](https://github.com/backstage/backstage/tree/master/packages/test-utils/)
+### [`test-utils`](https://github.com/backstage/backstage/tree/master/packages/test-utils/)
 
 Utilities for writing tests for Backstage plugins and apps.
 
 Stability: `2`
 
-### [test-utils-core](https://github.com/backstage/backstage/tree/master/packages/test-utils-core/)
+### [`test-utils-core`](https://github.com/backstage/backstage/tree/master/packages/test-utils-core/)
 
 Internal testing utilities that are separated out for usage in
 @backstage/core-api. All exports are re-exported by @backstage/test-utils. This
@@ -199,7 +199,7 @@ package should not be depended on directly.
 
 Stability: See @backstage/test-utils
 
-### [theme](https://github.com/backstage/backstage/tree/master/packages/theme/)
+### [`theme`](https://github.com/backstage/backstage/tree/master/packages/theme/)
 
 The core Backstage MUI theme along with customization utilities.
 
@@ -225,21 +225,21 @@ Many backend plugins are split into "REST API" and "TypeScript Interface"
 sections. The "TypeScript Interface" refers to the API used to integrate the
 plugin into the backend.
 
-### [api-docs](https://github.com/backstage/backstage/tree/master/plugins/api-docs/)
+### [`api-docs`](https://github.com/backstage/backstage/tree/master/plugins/api-docs/)
 
 Components to discover and display API entities as an extension to the catalog
 plugin.
 
 Stability: `0`
 
-### [app-backend](https://github.com/backstage/backstage/tree/master/plugins/app-backend/)
+### [`app-backend`](https://github.com/backstage/backstage/tree/master/plugins/app-backend/)
 
 A backend plugin that can be used to serve the frontend app and inject
 configuration.
 
 Stability: `2`
 
-### [auth-backend](https://github.com/backstage/backstage/tree/master/plugins/auth-backend/)
+### [`auth-backend`](https://github.com/backstage/backstage/tree/master/plugins/auth-backend/)
 
 A backend plugin that implements the backend portion of the various
 authentication flows used in Backstage.
@@ -252,7 +252,7 @@ Stability: `2`
 
 Stability: `1`
 
-### [catalog](https://github.com/backstage/backstage/tree/master/plugins/catalog/)
+### [`catalog`](https://github.com/backstage/backstage/tree/master/plugins/catalog/)
 
 The frontend plugin for the catalog, with the table and building blocks for the
 entity pages.
@@ -260,7 +260,7 @@ entity pages.
 Stability: `1`. We're planning some work to overhaul how entity pages are
 constructed.
 
-### [catalog-backend](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend/)
+### [`catalog-backend`](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend/)
 
 The backend API for the catalog, also exposes the processing subsystem for
 customization of the catalog. Powers the @backstage/plugin-catalog frontend
@@ -274,52 +274,52 @@ Stability: `1`. There are plans to remove and rework some endpoints.
 
 Stability: `1`. There are plans to rework parts of the Processor interface.
 
-### [catalog-graphql](https://github.com/backstage/backstage/tree/master/plugins/catalog-graphql/)
+### [`catalog-graphql`](https://github.com/backstage/backstage/tree/master/plugins/catalog-graphql/)
 
 Provides the catalog schema and resolvers for the graphql backend.
 
 Stability: `0`. Under heavy development and subject to change.
 
-### [circleci](https://github.com/backstage/backstage/tree/master/plugins/circleci/)
+### [`circleci`](https://github.com/backstage/backstage/tree/master/plugins/circleci/)
 
 Automate your development process with CI hosted in the cloud or on a private
 server.
 
 Stability: `0`
 
-### [cloudbuild](https://github.com/backstage/backstage/tree/master/plugins/cloudbuild/)
+### [`cloudbuild`](https://github.com/backstage/backstage/tree/master/plugins/cloudbuild/)
 
 Visualize Google Cloud Build flows.
 
 Stability: `0`
 
-### [cost-insights](https://github.com/backstage/backstage/tree/master/plugins/cost-insights/)
+### [`cost-insights`](https://github.com/backstage/backstage/tree/master/plugins/cost-insights/)
 
 Visualize, understand and optimize your team's cloud costs.
 
 Stability: `0`
 
-### [explore](https://github.com/backstage/backstage/tree/master/plugins/explore/)
+### [`explore`](https://github.com/backstage/backstage/tree/master/plugins/explore/)
 
 A frontend plugin that introduces the concept of exploring internal and external
 tooling in an organization.
 
 Stability: `0`. Only an example at the moment and not customizable.
 
-### [gcp-projects](https://github.com/backstage/backstage/tree/master/plugins/gcp-projects/)
+### [`gcp-projects`](https://github.com/backstage/backstage/tree/master/plugins/gcp-projects/)
 
 Create, list and manage your Google Cloud Projects.
 
 Stability: `0`
 
-### [github-actions](https://github.com/backstage/backstage/tree/master/plugins/github-actions/)
+### [`github-actions`](https://github.com/backstage/backstage/tree/master/plugins/github-actions/)
 
 GitHub Actions makes it easy to automate all your software workflows, now with
 world-class CI/CD. Build, test, and deploy your code right from GitHub.
 
 Stability: `0`
 
-### [gitops-profiles](https://github.com/backstage/backstage/tree/master/plugins/gitops-profiles/)
+### [`gitops-profiles`](https://github.com/backstage/backstage/tree/master/plugins/gitops-profiles/)
 
 A frontend plugin with a separate backend that can be used to provision EKS
 clusters.
@@ -327,56 +327,56 @@ clusters.
 Stability: `0`. This is an early plugin that now has quite a lot of overlap with
 the scaffolder plugin.
 
-### [graphiql](https://github.com/backstage/backstage/tree/master/plugins/graphiql/)
+### [`graphiql`](https://github.com/backstage/backstage/tree/master/plugins/graphiql/)
 
 Integrates GraphiQL as a tool to browse GraphQL API endpoints inside Backstage.
 
 Stability: `1`
 
-### [graphql](https://github.com/backstage/backstage/tree/master/plugins/graphql/)
+### [`graphql`](https://github.com/backstage/backstage/tree/master/plugins/graphql/)
 
 A backend plugin that provides
 
 Stability: `0`. Under heavy development and subject to change.
 
-### [jenkins](https://github.com/backstage/backstage/tree/master/plugins/jenkins/)
+### [`jenkins`](https://github.com/backstage/backstage/tree/master/plugins/jenkins/)
 
 A plugin that visualizes Jenkins workflows for entities. Jenkins offers a simple
 way to set up a continuous integration and continuous delivery environment.
 
 Stability: `0`
 
-### [kubernetes](https://github.com/backstage/backstage/tree/master/plugins/kubernetes/)
+### [`kubernetes`](https://github.com/backstage/backstage/tree/master/plugins/kubernetes/)
 
 The frontend component of the Kubernetes plugin, used to browse and visualize
 Kubernetes resources. Stability: `1`.
 
-### [kubernetes-backend](https://github.com/backstage/backstage/tree/master/plugins/kubernetes-backend/)
+### [`kubernetes-backend`](https://github.com/backstage/backstage/tree/master/plugins/kubernetes-backend/)
 
 The backend component of the Kubernetes plugin, used to fetch Kubernetes
 resources from clusters and associate them with entities in the Catalog.
 Stability: `1`.
 
-### [lighthouse](https://github.com/backstage/backstage/tree/master/plugins/lighthouse/)
+### [`lighthouse`](https://github.com/backstage/backstage/tree/master/plugins/lighthouse/)
 
 Google's Lighthouse tool is a great resource for benchmarking and improving the
 accessibility, performance, SEO, and best practices of your website.
 
 Stability: `0`
 
-### [newrelic](https://github.com/backstage/backstage/tree/master/plugins/newrelic/)
+### [`newrelic`](https://github.com/backstage/backstage/tree/master/plugins/newrelic/)
 
 Observability platform built to help engineers create and monitor their
 software. Stability: `0`
 
-### [proxy-backend](https://github.com/backstage/backstage/tree/master/plugins/proxy-backend/)
+### [`proxy-backend`](https://github.com/backstage/backstage/tree/master/plugins/proxy-backend/)
 
 A backend plugin used to set up proxying to other endpoints based on static
 configuration.
 
 Stability: `1`
 
-### [register-component](https://github.com/backstage/backstage/tree/master/plugins/register-component/)
+### [`register-component`](https://github.com/backstage/backstage/tree/master/plugins/register-component/)
 
 A frontend plugin that allows the user to register entity locations in the
 catalog.
@@ -384,28 +384,28 @@ catalog.
 Stability: `0`. This plugin is likely to be replaced by a generic entity import
 plugin instead.
 
-### [rollbar](https://github.com/backstage/backstage/tree/master/plugins/rollbar/)
+### [`rollbar`](https://github.com/backstage/backstage/tree/master/plugins/rollbar/)
 
 The frontend component of the rollbar plugin, which can be used to view Rollbar
 errors for your services in Backstage.
 
 Stability: `0`
 
-### [rollbar-backend](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend/)
+### [`rollbar-backend`](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend/)
 
 The backend component of the rollbar plugin, which can be used to view Rollbar
 errors for your services in Backstage.
 
 Stability: `0`
 
-### [scaffolder](https://github.com/backstage/backstage/tree/master/plugins/scaffolder/)
+### [`scaffolder`](https://github.com/backstage/backstage/tree/master/plugins/scaffolder/)
 
 The frontend scaffolder plugin where one can browse templates and initiate
 scaffolding jobs.
 
 Stability: `1`
 
-### [scaffolder-backend](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/)
+### [`scaffolder-backend`](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/)
 
 The backend scaffolder plugin that provides an implementation for templates in
 the catalog.
@@ -413,55 +413,55 @@ the catalog.
 Stability: `1`. There is planned work to rework the scaffolder in
 https://github.com/backstage/backstage/issues/2771.
 
-### [sentry](https://github.com/backstage/backstage/tree/master/plugins/sentry/)
+### [`sentry`](https://github.com/backstage/backstage/tree/master/plugins/sentry/)
 
 The frontend component of the sentry plugin, which can be used to view Sentry
 issues in Backstage.
 
 Stability: `0`
 
-### [sentry-backend](https://github.com/backstage/backstage/tree/master/plugins/sentry-backend/)
+### [`sentry-backend`](https://github.com/backstage/backstage/tree/master/plugins/sentry-backend/)
 
 The backend component of the sentry plugin, which can be used to view Sentry
 issues in Backstage.
 
 Stability: `0`
 
-### [sonarqube](https://github.com/backstage/backstage/tree/master/plugins/sonarqube/)
+### [`sonarqube`](https://github.com/backstage/backstage/tree/master/plugins/sonarqube/)
 
 Components to display code quality metrics from SonarCloud and SonarQube.
 
 Stability: `0`
 
-### [tech-radar](https://github.com/backstage/backstage/tree/master/plugins/tech-radar/)
+### [`tech-radar`](https://github.com/backstage/backstage/tree/master/plugins/tech-radar/)
 
 Visualize the your company's official guidelines of different areas of software
 development.
 
 Stability: `0`
 
-### [techdocs](https://github.com/backstage/backstage/tree/master/plugins/techdocs/)
+### [`techdocs`](https://github.com/backstage/backstage/tree/master/plugins/techdocs/)
 
 The frontend component of the TechDocs plugin, used to browse technical
 documentation of entities.
 
 Stability: `1`
 
-### [techdocs-backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/)
+### [`techdocs-backend`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/)
 
 The backend component of the TechDocs plugin, used to transform and serve
 TechDocs.
 
 Stability: `1`
 
-### [user-settings](https://github.com/backstage/backstage/tree/master/plugins/user-settings/)
+### [`user-settings`](https://github.com/backstage/backstage/tree/master/plugins/user-settings/)
 
 A frontend plugin that provides a page where the user can tweak various
 settings.
 
 Stability: `1`
 
-### [welcome](https://github.com/backstage/backstage/tree/master/plugins/welcome/)
+### [`welcome`](https://github.com/backstage/backstage/tree/master/plugins/welcome/)
 
 A plugin that can be used to welcome the user to Backstage.
 

From 3457c40f81dc178a1e401acbb703314fc96e501a Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Wed, 18 Nov 2020 10:24:15 +0100
Subject: [PATCH 5/7] Apply suggestions from code review

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
---
 docs/overview/stability-index.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
index 96ff33542f..1ec90e106d 100644
--- a/docs/overview/stability-index.md
+++ b/docs/overview/stability-index.md
@@ -349,12 +349,15 @@ Stability: `0`
 ### [`kubernetes`](https://github.com/backstage/backstage/tree/master/plugins/kubernetes/)
 
 The frontend component of the Kubernetes plugin, used to browse and visualize
-Kubernetes resources. Stability: `1`.
+Kubernetes resources.
+
+Stability: `1`.
 
 ### [`kubernetes-backend`](https://github.com/backstage/backstage/tree/master/plugins/kubernetes-backend/)
 
 The backend component of the Kubernetes plugin, used to fetch Kubernetes
 resources from clusters and associate them with entities in the Catalog.
+
 Stability: `1`.
 
 ### [`lighthouse`](https://github.com/backstage/backstage/tree/master/plugins/lighthouse/)
@@ -367,7 +370,9 @@ Stability: `0`
 ### [`newrelic`](https://github.com/backstage/backstage/tree/master/plugins/newrelic/)
 
 Observability platform built to help engineers create and monitor their
-software. Stability: `0`
+software.
+
+Stability: `0`
 
 ### [`proxy-backend`](https://github.com/backstage/backstage/tree/master/plugins/proxy-backend/)
 

From 102f0b394687a2464ac72e2bf87047f41ca9e2bd Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Wed, 18 Nov 2020 11:28:17 +0100
Subject: [PATCH 6/7] docs/stability-index: trim down list of plugins but open
 up for contributions + set techdocs-backend to 0

---
 .github/styles/vocab.txt         |   1 +
 docs/overview/stability-index.md | 101 ++-----------------------------
 2 files changed, 6 insertions(+), 96 deletions(-)

diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt
index bd89163f1f..b9d9e53dfa 100644
--- a/.github/styles/vocab.txt
+++ b/.github/styles/vocab.txt
@@ -196,6 +196,7 @@ toolsets
 tooltip
 touchpoints
 ui
+untracked
 upvote
 url
 utils
diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
index 1ec90e106d..f5a769c601 100644
--- a/docs/overview/stability-index.md
+++ b/docs/overview/stability-index.md
@@ -225,6 +225,10 @@ Many backend plugins are split into "REST API" and "TypeScript Interface"
 sections. The "TypeScript Interface" refers to the API used to integrate the
 plugin into the backend.
 
+Any plugin that is not listed below is untracked and can generally be considered
+unstable with a score of `0`. Open a Pull Request if you want your plugin to be
+added!
+
 ### [`api-docs`](https://github.com/backstage/backstage/tree/master/plugins/api-docs/)
 
 Components to discover and display API entities as an extension to the catalog
@@ -280,25 +284,6 @@ Provides the catalog schema and resolvers for the graphql backend.
 
 Stability: `0`. Under heavy development and subject to change.
 
-### [`circleci`](https://github.com/backstage/backstage/tree/master/plugins/circleci/)
-
-Automate your development process with CI hosted in the cloud or on a private
-server.
-
-Stability: `0`
-
-### [`cloudbuild`](https://github.com/backstage/backstage/tree/master/plugins/cloudbuild/)
-
-Visualize Google Cloud Build flows.
-
-Stability: `0`
-
-### [`cost-insights`](https://github.com/backstage/backstage/tree/master/plugins/cost-insights/)
-
-Visualize, understand and optimize your team's cloud costs.
-
-Stability: `0`
-
 ### [`explore`](https://github.com/backstage/backstage/tree/master/plugins/explore/)
 
 A frontend plugin that introduces the concept of exploring internal and external
@@ -306,27 +291,6 @@ tooling in an organization.
 
 Stability: `0`. Only an example at the moment and not customizable.
 
-### [`gcp-projects`](https://github.com/backstage/backstage/tree/master/plugins/gcp-projects/)
-
-Create, list and manage your Google Cloud Projects.
-
-Stability: `0`
-
-### [`github-actions`](https://github.com/backstage/backstage/tree/master/plugins/github-actions/)
-
-GitHub Actions makes it easy to automate all your software workflows, now with
-world-class CI/CD. Build, test, and deploy your code right from GitHub.
-
-Stability: `0`
-
-### [`gitops-profiles`](https://github.com/backstage/backstage/tree/master/plugins/gitops-profiles/)
-
-A frontend plugin with a separate backend that can be used to provision EKS
-clusters.
-
-Stability: `0`. This is an early plugin that now has quite a lot of overlap with
-the scaffolder plugin.
-
 ### [`graphiql`](https://github.com/backstage/backstage/tree/master/plugins/graphiql/)
 
 Integrates GraphiQL as a tool to browse GraphQL API endpoints inside Backstage.
@@ -339,13 +303,6 @@ A backend plugin that provides
 
 Stability: `0`. Under heavy development and subject to change.
 
-### [`jenkins`](https://github.com/backstage/backstage/tree/master/plugins/jenkins/)
-
-A plugin that visualizes Jenkins workflows for entities. Jenkins offers a simple
-way to set up a continuous integration and continuous delivery environment.
-
-Stability: `0`
-
 ### [`kubernetes`](https://github.com/backstage/backstage/tree/master/plugins/kubernetes/)
 
 The frontend component of the Kubernetes plugin, used to browse and visualize
@@ -360,20 +317,6 @@ resources from clusters and associate them with entities in the Catalog.
 
 Stability: `1`.
 
-### [`lighthouse`](https://github.com/backstage/backstage/tree/master/plugins/lighthouse/)
-
-Google's Lighthouse tool is a great resource for benchmarking and improving the
-accessibility, performance, SEO, and best practices of your website.
-
-Stability: `0`
-
-### [`newrelic`](https://github.com/backstage/backstage/tree/master/plugins/newrelic/)
-
-Observability platform built to help engineers create and monitor their
-software.
-
-Stability: `0`
-
 ### [`proxy-backend`](https://github.com/backstage/backstage/tree/master/plugins/proxy-backend/)
 
 A backend plugin used to set up proxying to other endpoints based on static
@@ -389,20 +332,6 @@ catalog.
 Stability: `0`. This plugin is likely to be replaced by a generic entity import
 plugin instead.
 
-### [`rollbar`](https://github.com/backstage/backstage/tree/master/plugins/rollbar/)
-
-The frontend component of the rollbar plugin, which can be used to view Rollbar
-errors for your services in Backstage.
-
-Stability: `0`
-
-### [`rollbar-backend`](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend/)
-
-The backend component of the rollbar plugin, which can be used to view Rollbar
-errors for your services in Backstage.
-
-Stability: `0`
-
 ### [`scaffolder`](https://github.com/backstage/backstage/tree/master/plugins/scaffolder/)
 
 The frontend scaffolder plugin where one can browse templates and initiate
@@ -418,26 +347,6 @@ the catalog.
 Stability: `1`. There is planned work to rework the scaffolder in
 https://github.com/backstage/backstage/issues/2771.
 
-### [`sentry`](https://github.com/backstage/backstage/tree/master/plugins/sentry/)
-
-The frontend component of the sentry plugin, which can be used to view Sentry
-issues in Backstage.
-
-Stability: `0`
-
-### [`sentry-backend`](https://github.com/backstage/backstage/tree/master/plugins/sentry-backend/)
-
-The backend component of the sentry plugin, which can be used to view Sentry
-issues in Backstage.
-
-Stability: `0`
-
-### [`sonarqube`](https://github.com/backstage/backstage/tree/master/plugins/sonarqube/)
-
-Components to display code quality metrics from SonarCloud and SonarQube.
-
-Stability: `0`
-
 ### [`tech-radar`](https://github.com/backstage/backstage/tree/master/plugins/tech-radar/)
 
 Visualize the your company's official guidelines of different areas of software
@@ -457,7 +366,7 @@ Stability: `1`
 The backend component of the TechDocs plugin, used to transform and serve
 TechDocs.
 
-Stability: `1`
+Stability: `0`
 
 ### [`user-settings`](https://github.com/backstage/backstage/tree/master/plugins/user-settings/)
 

From acc226dd6335066db22ad480762a0ad8ed937ce1 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Wed, 18 Nov 2020 17:20:13 +0100
Subject: [PATCH 7/7] Update docs/overview/stability-index.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
---
 docs/overview/stability-index.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md
index f5a769c601..416cdcdd4a 100644
--- a/docs/overview/stability-index.md
+++ b/docs/overview/stability-index.md
@@ -41,14 +41,14 @@ TL;DR:
 
 ### [`example-app`](https://github.com/backstage/backstage/tree/master/packages/app/)
 
-This is the `packages/app` package, and it's serves as an example as well as
+This is the `packages/app` package, and it serves as an example as well as
 utility for local development in the main Backstage repo.
 
 Stability: `N/A`
 
 ### [`example-backend`](https://github.com/backstage/backstage/tree/master/packages/backend/)
 
-This is the `packages/backend` package, and it's serves as an example as well as
+This is the `packages/backend` package, and it serves as an example as well as
 utility for local development in the main Backstage repo.
 
 Stability: `N/A`