From 64164776a0697e5ea7586d610dd1d6f652797b6b Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:49:24 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466162074.md | 6 +++ plugins/org-react/README.md | 32 +-------------- plugins/org-react/package.json | 6 ++- plugins/org/README.md | 62 +---------------------------- plugins/org/package.json | 6 ++- 5 files changed, 18 insertions(+), 94 deletions(-) create mode 100644 .changeset/migrate-1713466162074.md diff --git a/.changeset/migrate-1713466162074.md b/.changeset/migrate-1713466162074.md new file mode 100644 index 0000000000..a23aa24226 --- /dev/null +++ b/.changeset/migrate-1713466162074.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-org': patch +'@backstage/plugin-org-react': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/org-react/README.md b/plugins/org-react/README.md index 1f87a5e7e6..e406877e66 100644 --- a/plugins/org-react/README.md +++ b/plugins/org-react/README.md @@ -1,31 +1,3 @@ -# org-react +# Deprecated -## features - -- Group list picker component - -### GroupListPicker - -The `GroupListPicker` component displays a select box which also has autocomplete functionality. - -To use the `GroupListPicker` component you'll need to import it and add it to your desired place. - -```diff -+ import { GroupListPicker } from '@backstage/plugin-org-react'; -+ import React, { useState } from 'react'; - -+ const [group, setGroup] = useState(); - - - -+ - - -``` - -The `GroupListPicker` comes with four props: - -- `groupTypes`: gives the user the option which group types the component should load. If no value is provided all group types will be loaded in; -- `placeholder`: the placeholder that the select box in the component should display. This might be helpful in informing your users what the functionality of the component is. -- `onChange`: a prop to help the user to give access to the selected group -- `defaultValue`: gives the user the option to define a default value that will be shown initially before making a selection +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-org-react` instead. diff --git a/plugins/org-react/package.json b/plugins/org-react/package.json index b56d916e89..801d7f187f 100644 --- a/plugins/org-react/package.json +++ b/plugins/org-react/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-org-react", "version": "0.1.23", "backstage": { - "role": "web-library" + "role": "web-library", + "moved": "@backstage-community/plugin-org-react" }, "publishConfig": { "access": "public", @@ -59,5 +60,6 @@ "react": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" - } + }, + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-org-react instead." } diff --git a/plugins/org/README.md b/plugins/org/README.md index 9cf165f06d..c3ec43c7e3 100644 --- a/plugins/org/README.md +++ b/plugins/org/README.md @@ -1,61 +1,3 @@ -# Org Plugin for Backstage +# Deprecated -> Disclaimer: -> If you are looking for documentation on the experimental new frontend system support, please go [here](./README-alpha.md). - -## Features - -- Show Group Page -- Show User Profile -- Quick access to Groups - -### Group Page - -Here's an example of what the Group Page looks like: - -![Group Page example](./docs/group-page-example.png) - -### User Profile - -Here's an example of what the User Profile looks like: - -![Group Page example](./docs/user-profile-example.png) - -### MyGroupsSidebarItem - -The MyGroupsSidebarItem provides quick access to the group(s) the logged in user is a member of directly in the sidebar. - -To use the MyGroupsSidebarItem you'll need to add it to your `Root.tsx` - found at `packages\app\src\components\Root` - like this: - -```diff -+ import { MyGroupsSidebarItem } from '@backstage/plugin-org'; -+ import GroupIcon from '@material-ui/icons/People'; - - - - //... - }> - {/* Global nav, not org-specific */} - //... - -+ - //... - - - -``` - -Once added MyGroupsSidebarItem will work in three ways: - -1. The user is not logged in or the logged in user is not a member of any group: the MyGroupsSidebarItem will not display anything in the sidebar -2. The user is logged in and a member of only one group: the MyGroupsSidebarItem will display a single item in the sidebar like this: - - ![MyGroupsSidebarItem single example](./docs/mygroupssidebaritem-single.png) - -3. The user is logged in and a member of more than one group: the MyGroupsSidebarItem will display a single items with a sub-menu with all the related groups like this: - - ![MyGroupsSidebarItem multiple example](./docs/mygroupssidebaritem-multiple.png) +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-org` instead. diff --git a/plugins/org/package.json b/plugins/org/package.json index 173495d846..54b248a4b8 100644 --- a/plugins/org/package.json +++ b/plugins/org/package.json @@ -3,7 +3,8 @@ "version": "0.6.24", "description": "A Backstage plugin that helps you create entity pages for your organization", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-org" }, "publishConfig": { "access": "public" @@ -82,5 +83,6 @@ "react": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" - } + }, + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-org instead." }