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

core,core-api: add deprecation warnings to package READMEs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-06-22 17:16:07 +02:00
parent 7ada8c7d9a
commit a1c30d7ea8
3 changed files with 12 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/wet-suits-attack.md
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/core': patch
'@backstage/core-api': patch
---
Add deprecation warning to package README.
packages/core-api/README.md
+3 -13
View File
@@ -1,20 +1,10 @@
# @backstage/core-api
This package provides the core API used by Backstage plugins and apps.
**NOTE: This package is deprecated**
## Installation
See the [migration documentation](https://backstage.io/docs/tutorials/migrating-away-from-core) for details on how to move to using the newer packages, [`@backstage/core-app-api`](https://www.npmjs.com/package/@backstage/core-app-api), [`@backstage/core-components`](https://www.npmjs.com/package/@backstage/core-components), and [`@backstage/core-plugin-api`](https://www.npmjs.com/package/@backstage/core-plugin-api)
Do not install this package directly, it is reexported by `@backstage/core`. Install that instead:
```sh
npm install --save @backstage/core
```
or
```sh
yarn add @backstage/core
```
This package used to provide the core API used by Backstage plugins and apps.
## Documentation
packages/core/README.md
+3 -13
View File
@@ -1,20 +1,10 @@
# @backstage/core
This package provides the core API used by Backstage plugins and apps.
**NOTE: This package is deprecated**
## Installation
See the [migration documentation](https://backstage.io/docs/tutorials/migrating-away-from-core) for details on how to move to using the newer packages, [`@backstage/core-app-api`](https://www.npmjs.com/package/@backstage/core-app-api), [`@backstage/core-components`](https://www.npmjs.com/package/@backstage/core-components), and [`@backstage/core-plugin-api`](https://www.npmjs.com/package/@backstage/core-plugin-api)
Install the package via npm or Yarn:
```sh
npm install --save @backstage/core
```
or
```sh
yarn add @backstage/core
```
This package used to provide the core API and components used by Backstage plugins and apps.
## Documentation