Backstage plugin for displaying Revision diagrams
npm install @revisionapp/backstage-revision-pluginThe Revision plugin displays diagrams from Revision.
1. Install the Revision plugin:
``bashFrom your Backstage root directory
yarn add --cwd packages/app @revisionapp/backstage-revision-plugin
`
2. Add the EntitySentryCard to the EntityPage:
`javascript
// packages/app/src/components/catalog/EntityPage.tsx
import { EntityRevisionContent } from '@revisionapp/backstage-revision-plugin';
const serviceEntityPage = (
// ...
// ...
);
`
3. Add the proxy config and Revision base url to your app config:
`yamlapp-config.yaml
proxy:
endpoints:
'/revision':
target: https://
headers:
Authorization: 'Bearer ${REVISION_API_KEY}'
revision:
baseUrl: https://
`
4. Add the revision.app/diagram-slug annotation to your catalog info file:
`yamlcatalog-info.yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: backstage
description: |
Backstage is an open-source developer portal that puts the developer experience first.
annotations:
revision.app/diagram-slug: YOUR_DIAGRAM_SLUG
spec:
type: library
owner: CNCF
lifecycle: experimental
`
5. Set your Revision organization's API key, located under "Settings" > "Security" in Revision (requires administrator access), as an environmental variable called REVISION_API_KEY`.