Deprecate packages

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:50:29 +02:00
parent 7409696ccd
commit 441e20753d
5 changed files with 18 additions and 59 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-stack-overflow': patch
'@backstage/plugin-stack-overflow-backend': patch
---
These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
+2 -2
View File
@@ -1,3 +1,3 @@
# Stack Overflow Backend
# Deprecated
Deprecated, consider using `@backstage/plugin-search-backend-module-stack-overflow-collator` instead.
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-stack-overflow-backend` instead.
+4 -2
View File
@@ -3,7 +3,8 @@
"version": "0.2.21",
"description": "Deprecated, consider using @backstage/plugin-search-backend-module-stack-overflow-collator instead",
"backstage": {
"role": "backend-plugin"
"role": "backend-plugin",
"moved": "@backstage-community/plugin-stack-overflow-backend"
},
"publishConfig": {
"access": "public",
@@ -46,5 +47,6 @@
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^"
},
"configSchema": "config.d.ts"
"configSchema": "config.d.ts",
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-stack-overflow-backend instead."
}
+2 -53
View File
@@ -1,54 +1,3 @@
# Stack Overflow
# Deprecated
A plugin that provides stack overflow specific functionality that can be used in different ways (e.g. for homepage and search) to compose your Backstage App.
## Getting started
Before we begin, make sure:
- You have created your own standalone Backstage app using @backstage/create-app and not using a fork of the backstage repository. If you haven't setup Backstage already, start [here](https://backstage.io/docs/getting-started/).
To use any of the functionality this plugin provides, you need to start by configuring your App with the following config:
```yaml
stackoverflow:
baseUrl: https://api.stackexchange.com/2.2 # alternative: your internal stack overflow instance
```
## Areas of Responsibility
This stack overflow frontend plugin is primarily responsible for the following:
- Exposing various stack-overflow related components like `<StackOverflowSearchResultListItem />` which can be used for composing the search page, and `<HomePageStackOverflowQuestions/>` which can be used for composing the homepage.
#### Use specific search result list item for Stack Overflow Question
> Note: For Stack Overflow specific search results to be returned, it needs to be indexed. Use the [stack-overflow-backend plugin](https://github.com/backstage/backstage/blob/master/plugins/stack-overflow-backend/README.md) to index Stack Overflow Questions to search.
When you have your `packages/app/src/components/search/SearchPage.tsx` file ready to make modifications, add the following code snippet to add the `StackOverflowSearchResultListItem` when the type of the search results are `stack-overflow`.
```tsx
case 'stack-overflow':
return (
<StackOverflowSearchResultListItem
key={document.location}
result={document}
/>
);
```
#### Use Stack Overflow Questions on your homepage
Before you are able to add the stack overflow question component to your homepage, you need to go through the [homepage getting started guide](https://backstage.io/docs/getting-started/homepage). When its ready, add the following code snippet to your `packages/app/src/components/home/HomePage.tsx` file.
```tsx
<Grid item xs={12} md={6}>
<HomePageStackOverflowQuestions
requestParams={{
tagged: 'backstage',
site: 'stackoverflow',
pagesize: 5,
}}
/>
</Grid>
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-stack-overflow` instead.
+4 -2
View File
@@ -2,7 +2,8 @@
"name": "@backstage/plugin-stack-overflow",
"version": "0.1.29",
"backstage": {
"role": "frontend-plugin"
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-stack-overflow"
},
"publishConfig": {
"access": "public"
@@ -75,5 +76,6 @@
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
},
"configSchema": "config.d.ts"
"configSchema": "config.d.ts",
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-stack-overflow instead."
}