clean up plugin docs

Signed-off-by: Kurt King <[email protected]>

Author: kurtaking

workspaces/announcements/README.md

@@ -1,16 +1,17 @@
-# Announcements plugin for Backstage
+# Backstage Announcements Plugin
 
-The Announcements plugin manages and displays announcements within Backstage.
+The Announcements plugin manages and displays announcements within Backstage with support for categories and tags.
 
 ## Plugins
 
 This plugin is composed of several packages:
 
 - [announcements](./plugins/announcements/README.md) - The frontend plugin that provides the UI components and pages.
 - [announcements-backend](./plugins/announcements-backend/README.md) - The backend plugin that provides the REST API and database model.
-- [announcements-node](./plugins/announcements-node/README.md) - A node library containing reusable service logic.
 - [announcements-common](./plugins/announcements-common/README.md) - A common library containing shared types and utilities.
+- [announcements-node](./plugins/announcements-node/README.md) - A node library containing reusable service logic.
 - [announcements-react](./plugins/announcements-react/README.md) - A web library containing announcements-related react components.
+- [search-backend-module-announcements](./plugins/search-backend-module-announcements/README.md) - A backend module that provides search capabilities for announcements.
 
 ## Quick start
 

workspaces/announcements/plugins/README.md

@@ -1,9 +1,7 @@
-# The Plugins Folder
+# Announcements Plugins
 
-This is where your own plugins and their associated modules live, each in a
-separate folder of its own.
+This is where the plugins and their associated modules for the Announcements plugin live, each in a
+separate folder.
 
-If you want to create a new plugin here, go to your project root directory, run
+If you want to create a new plugin here, go to the project root directory, run
 the command `yarn new`, and follow the on-screen instructions.
-
-You can also check out existing plugins on [the plugin marketplace](https://backstage.io/plugins)!

workspaces/announcements/plugins/announcements-common/README.md

@@ -1,6 +1,6 @@
 # @backstage-community/plugin-announcements-common
 
-This package provides shared types and utilities for the Announcements plugin.
+This package provides shared types and utilities for all Announcements-related plugins.
 
 ## Installation
 

workspaces/announcements/plugins/announcements-node/README.md

@@ -2,14 +2,9 @@
 
 Exports shared types and services for backend-related announcements functionality.
 
-## Events support
-
-The announcements plugin supports the Backstage Event system. View the [events](./docs/events.md) documentation for more information.
-
-## Signals support
-
-The announcements plugin supports the Backstage Signal system. View the [signals](./docs/signals.md) documentation for more information.
+- [Events](./docs/events.md) support - The node library supports the Backstage Event system.
+- [Signals](./docs/signals.md) support - The node library supports the Backstage Signal system.
 
 ## Previously maintained by
 
-- [procore-oss](https://github.com/procore-oss/backstage-plugin-announcements/tree/main/plugins/announcements-node)
+- [procore-oss](https://github.com/procore-oss/backstage-plugin-announcements)

workspaces/announcements/plugins/announcements/README.md

@@ -2,14 +2,12 @@
 
 The frontend for the Announcements plugin.
 
-## Features
+## Table of Contents
 
-This plugin provides:
-
-- pages to list, view, create, edit and delete announcements
-- a component to display the latest announcements, for example on a homepage
-- a component to display the latest announcement as a banner, if there is one
-- an admin portal to manage announcements
+- [Installation](#installation)
+- [New Frontend System (Alpha)](#new-frontend-system-alpha)
+- [Components](#components)
+- [Customization](#customization)
 
 ## Installation
 
@@ -31,14 +29,15 @@ const AppRoutes = () => (
   <FlatRoutes>
     // ...
     <Route path="/announcements" element={<AnnouncementsPage />} />
+    <Route path="/announcements/admin" element={<AdminPortal />} />
     // ...
   </FlatRoutes>
 );
 ```
 
-An interface to create/update/edit/delete announcements is now available at `/announcements`.
+Viewing announcements is now available at `/announcements`. Managing announcements, categories and tags is now available at `/announcements/admin`. The admin portal is also available via the context menu on the announcements page.
 
-## New Frontend System Setup (Alpha)
+### New Frontend System (Alpha)
 
 Add the plugin to your frontend app:
 
@@ -86,6 +85,8 @@ app:
 
 ## Components
 
+- Page to view announcements
+- Unified admin portal to manage announcements, categories and tags
 - [Display latest announcements on a page](./docs/latest-announcements-on-page.md)
 - [Display a banner for the latest announcement](./docs/latest-announcement-banner.md)
 - [Display announcements in a timeline](./docs/announcement-timeline.md)
@@ -130,16 +131,6 @@ Example
 <AnnouncementsPage category="conferences" />
 ```
 
-### Overriding the AnnouncementCreateButton
-
-It is possible to specify the text for the "New announcement" button rendered on the `AnnouncementsPage`. You can do this by passing a `buttonOptions` prop to the `AnnouncementsPage` component. The `buttonOptions` prop accepts an object with the following properties:
-
-```ts
-{
-  name: string; // defaults to 'announcement'
-}
-```
-
 ### Overriding the NewAnnouncementBanner
 
 It is possible to specify the length of the title for announcements rendered on the `NewAnnouncementBanner`. You can do this by passing a `cardOptions` prop to the `NewAnnouncementBanner` component. The `cardOptions` prop accepts an object with the following properties:
@@ -175,16 +166,6 @@ You can select the markdown renderer when using the AnnouncementsPage component:
 
 Select the renderer that best fits your needs based on whether theme consistency or markdown feature completeness is more important for your use case.
 
-## Development
-
-### Getting started
-
-Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/announcements](http://localhost:3000/announcements).
-
-You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
-This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
-It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
-
 ## Previously maintained by
 
 - [procore-oss](https://github.com/procore-oss/backstage-plugin-announcements/tree/main/plugins/announcements)

workspaces/announcements/plugins/announcements/src/components/Admin/AdminPortal/AdminPortal.tsx

@@ -82,7 +82,7 @@ export const AdminPortal = (props?: AdminPortalProps) => {
   const { t } = useAnnouncementsTranslation();
 
   return (
-    <Page themeId={themeId ?? 'tool'}>
+    <Page themeId={themeId ?? 'home'}>
       <Header
         title={title ?? t('admin.adminPortal.title')}
         subtitle={subtitle ?? t('admin.adminPortal.title')}

workspaces/announcements/plugins/search-backend-module-announcements/README.md

@@ -1,6 +1,59 @@
 # @backstage-community/plugin-search-backend-module-announcements
 
-The announcements backend module for the search plugin.
+The announcements backend module for the `@backstage/plugin-search` plugin.
+
+![Announcements search results](./images/announcements_search.png)
+
+## Installation
+
+Add the module to your backend package.
+
+```bash
+yarn add --cwd packages/backend @backstage-community/plugin-search-backend-module-announcements
+```
+
+Update `packages/backend/src/index.ts` to import the announcements search module and register it with the backend.
+
+```ts
+// ...
+const backend = createBackend();
+
+// ...
+
+backend.add(import('@backstage-community/plugin-announcements-backend'));
+backend.add(
+  import('@backstage-community/plugin-search-backend-module-announcements'),
+);
+// ...
+```
+
+## Adding search support to the frontend
+
+Add the announcement search result list item to your search results.
+
+```tsx
+import { AnnouncementSearchResultListItem } from '@backstage-community/plugin-announcements';
+import RecordVoiceOverIcon from '@material-ui/icons/RecordVoiceOver';
+
+// ...
+<SearchType.Accordion
+  name="Result Type"
+  defaultValue="software-catalog"
+  types={[
+    // ...
+    {
+      value: 'announcements',
+      name: 'Announcements',
+      icon: <RecordVoiceOverIcon />,
+    },
+  ]}
+/>
+
+<SearchResult>
+  // ...
+  <AnnouncementSearchResultListItem />
+</SearchResult>
+```
 
 ## Previously maintained by
 

workspaces/announcements/plugins/search-backend-module-announcements/docs/search.md

@@ -22,6 +22,7 @@
 
 export { searchModuleAnnouncementsCollator as default } from './module';
 
+// todo: I dont think these need to be exported anymore
 export { AnnouncementCollatorFactory } from './collators/AnnouncementCollatorFactory';
 export type {
   IndexableAnnouncementDocument,