Merge pull request #10528 from LvffY/master

Update documentation
This commit is contained in:
Ben Lambert
2022-04-01 10:55:41 +02:00
committed by GitHub
48 changed files with 75 additions and 113 deletions
+3 -3
View File
@@ -6,9 +6,9 @@ This package provides a default wiring of a Backstage app that avoids boilerplat
Install the package via Yarn:
```sh
cd packages/app
yarn add @backstage/app-defaults
```bash
# From your Backstage root directory
yarn add --cwd packages/app @backstage/app-defaults
```
## Documentation
+2 -3
View File
@@ -7,10 +7,9 @@ error handling and similar.
Add the library to your backend package:
```sh
```bash
# From your Backstage root directory
cd packages/backend
yarn add @backstage/backend-common
yarn add --cwd packages/backend @backstage/backend-common
```
then make use of the handlers and logger as necessary:
+2 -3
View File
@@ -6,10 +6,9 @@ Common distributed task management for Backstage backends.
Add the library to your backend package:
```sh
```bash
# From your Backstage root directory
cd packages/backend
yarn add @backstage/backend-tasks
yarn add --cwd packages/backend @backstage/backend-tasks
```
then make use of its facilities as necessary:
+2 -3
View File
@@ -6,9 +6,8 @@ This package provides the core API used by Backstage apps.
Install the package via Yarn:
```sh
cd packages/app
yarn add @backstage/core-app-api
```bash
yarn add --cwd packages/app @backstage/core-app-api
```
## Documentation
@@ -21,8 +21,9 @@ import {
import React, { ReactNode, useContext } from 'react';
import { AnalyticsContextValue } from './types';
const AnalyticsReactContext =
createVersionedContext<{ 1: AnalyticsContextValue }>('analytics-context');
const AnalyticsReactContext = createVersionedContext<{
1: AnalyticsContextValue;
}>('analytics-context');
/**
* A "private" (to this package) hook that enables context inheritance and a