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

docs/stability-index: wrap package titles in code blocks

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-11-13 13:54:49 +01:00
parent a969371bf6
commit b4c9e09b87
2 changed files with 53 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/styles/vocab.txt
-4
View File
@@ -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
docs/overview/stability-index.md
+53 -53
View File
@@ -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.