Skip to content

Commit

Permalink
docs: add description of plugin in first line of readme
Browse files Browse the repository at this point in the history
so that it displays well on npmjs
  • Loading branch information
zhammer committed Jan 31, 2024
1 parent 1943e0a commit 77b57d9
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 17 deletions.
4 changes: 2 additions & 2 deletions plugins/awards-backend/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @seatgeek/backstage-plugin-awards-backend

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards-backend/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards-backend)
This plugin provides the backend API for the awards plugin.

Welcome to the backend package for awards plugin!
[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards-backend/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards-backend)

This plugin relies on [Backstage authentication](https://backstage.io/docs/auth/)
in order to enforce ownership of awards. Please follow the documentation to
Expand Down
7 changes: 2 additions & 5 deletions plugins/awards-common/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# @seatgeek/backstage-plugin-awards-common

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards-common/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards-common)

Welcome to the common package for awards plugin!
This common package provides shared types and utility functions used by the frontend and backend awards plugin.

This common package provides shared types and utility functions used by the
frontend and backend awards plugin.
[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards-common/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards-common)

Every time we find the need to change the awards type or to add common utilities
for testing, we added it to this plugin.
Expand Down
6 changes: 2 additions & 4 deletions plugins/awards/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# @seatgeek/backstage-plugin-awards

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards)
This plugin offers a management system for awards that can be created and given to recipients in your Backstage deployment, and then displayed onto their Entity profile pages.

This plugin offers a management system for awards that can be created and given
to recipients in your Backstage deployment, and then displayed onto their
Entity profile pages.
[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-awards/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-awards)

The plugin offers a set of Page Components and an Information card to achieve
this. It also requires the installation of its dependency
Expand Down
4 changes: 2 additions & 2 deletions plugins/catalog-backend-module-okta/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# @seatgeek/backstage-plugin-catalog-backend-module-okta

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-catalog-backend-module-okta/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-catalog-backend-module-okta)

This plugin offers the ability to ingest users and groups from the [Okta API](https://developer.okta.com/docs/reference/core-okta-api/) into the Backstage catalog.

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-catalog-backend-module-okta/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-catalog-backend-module-okta)

## Installation

Install the @seatgeek/catalog-backend-module-okta package in your backend package:
Expand Down
4 changes: 2 additions & 2 deletions plugins/entity-scaffolder-content/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# @seatgeek/backstage-plugin-entity-scaffolder-content

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-entity-scaffolder-content/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-entity-scaffolder-content)

This plugin offers the ability to run Software Templates from within an entity's EntityPage. Templates, once selected, can be autopopulated with data from the Entity. For example, if I am on the EntityPage for `system:default/tickets` and I select a template for creating a new Postgres database, I can autopopulate that template's `system:` field to `system:default/tickets`.

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-entity-scaffolder-content/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-entity-scaffolder-content)

![Template groups visible on an EntityPage](screenshot-groups.png)

![Selected template with entity's information filled in](screenshot-selected.png)
Expand Down
4 changes: 2 additions & 2 deletions plugins/slack-catalog-backend/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# @seatgeek/backstage-plugin-slack-catalog-backend

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-slack-catalog-backend/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-slack-catalog-backend)

This plugin offers catalog integrations for ingesting data from the Slack API into the Software Catalog.

[![npm latest version](https://img.shields.io/npm/v/@seatgeek/backstage-plugin-slack-catalog-backend/latest.svg)](https://www.npmjs.com/package/@seatgeek/backstage-plugin-slack-catalog-backend)

## Installation

Install the `@seatgeek/backstage-plugin-slack-catalog-backend` package in your backend package:
Expand Down

0 comments on commit 77b57d9

Please sign in to comment.