diff --git a/.changeset/wet-suits-attack.md b/.changeset/wet-suits-attack.md new file mode 100644 index 0000000000..8506381dc5 --- /dev/null +++ b/.changeset/wet-suits-attack.md @@ -0,0 +1,6 @@ +--- +'@backstage/core': patch +'@backstage/core-api': patch +--- + +Add deprecation warning to package README. diff --git a/packages/core-api/README.md b/packages/core-api/README.md index a4325a9c5d..5a6430baa7 100644 --- a/packages/core-api/README.md +++ b/packages/core-api/README.md @@ -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 diff --git a/packages/core/README.md b/packages/core/README.md index 0f827d6074..adb295945c 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -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