badges: touch up readmes.
Signed-off-by: Andreas Stenius <git@astekk.se>
This commit is contained in:
committed by
Fredrik Adelöw
parent
0f30b99bc2
commit
d80bdf0324
@@ -0,0 +1,6 @@
|
||||
---
|
||||
'@backstage/plugin-badges': patch
|
||||
'@backstage/plugin-badges-backend': patch
|
||||
---
|
||||
|
||||
New plugin to serve badges.
|
||||
@@ -6,24 +6,21 @@ the badges, in svg.
|
||||
|
||||
## Setup
|
||||
|
||||
Define which badges to offer in the backend api by declaring them in
|
||||
the app-config, under a `badges` key. Example:
|
||||
The list of all badges to offer are passed to the badges-backend
|
||||
`createRouter()`.
|
||||
|
||||
You may also add/redefine badges in the `app-config.yaml`, under a
|
||||
`badges` key. Example:
|
||||
|
||||
```yaml
|
||||
badges:
|
||||
docs:
|
||||
kind: 'entity'
|
||||
target: '_{entity_url}/docs'
|
||||
label: 'Documentation'
|
||||
label: 'docs'
|
||||
message: '_{entity.metadata.name}'
|
||||
color: 'navyblue'
|
||||
|
||||
lifecycle:
|
||||
kind: 'entity'
|
||||
description: 'Entity lifecycle badge'
|
||||
target: '_{entity_url}'
|
||||
label: 'Lifecycle'
|
||||
message: '_{entity.spec.lifecycle}'
|
||||
style: for-the-badge
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
# badges
|
||||
# Badges
|
||||
|
||||
Welcome to the badges plugin!
|
||||
The badges plugin offers a set of badges that can be used outside of
|
||||
your backstage deployment, showing information related to data from
|
||||
the catalog, such as entity owner and lifecycle data for instance.
|
||||
|
||||
_This plugin was created through the Backstage CLI_
|
||||
The available badges are setup in the `badges-backend` plugin, see
|
||||
link below.
|
||||
|
||||
To get markdown code for the badges, access the `Badges` context menu
|
||||
(three dots in the upper right corner) of an entity page.
|
||||
|
||||
## Links
|
||||
|
||||
|
||||
Reference in New Issue
Block a user