Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

Commit

Permalink
Merge pull request #13 from procore-oss/migrate-to-pcor-oss
Browse files Browse the repository at this point in the history
initial commit
  • Loading branch information
kurtaking authored Oct 9, 2023
2 parents 1114ad6 + eed017e commit 5e95333
Show file tree
Hide file tree
Showing 23 changed files with 7,316 additions and 9,060 deletions.
6 changes: 3 additions & 3 deletions .changeset/many-hounds-happen.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
'@kurtaking/backstage-plugin-announcements-backend': minor
'@kurtaking/backstage-plugin-announcements-common': minor
'@kurtaking/backstage-plugin-announcements': minor
'@procore-oss/backstage-plugin-announcements-backend': minor
'@procore-oss/backstage-plugin-announcements-common': minor
'@procore-oss/backstage-plugin-announcements': minor
---

publish 0.1.0 version
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @procore-oss/procore-backstage-plugin-announcements @kurtaking
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ dist
!.yarn/versions

.env
.npmrc
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Contributions are welcome, and they are greatly appreciated! Every little bit he

The official support channels, for both users and contributors, are:

- GitHub [issues](https://github.com/kurtaking/backstage-plugin-announcements/issues)
- GitHub [issues](https://github.com/procore-oss/backstage-plugin-announcements/issues)

## How to Contribute

Expand All @@ -26,7 +26,7 @@ Pull Requests (PRs) are the main and exclusive way to contribute to the project.
```
git clone git@github.com:your_github_username/backstage-plugin-announcements.git
cd backstage-plugin-announcements
git remote add upstream https://github.com/kurtaking/backstage-plugin-announcements.git
git remote add upstream https://github.com/procore-oss/backstage-plugin-announcements.git
git fetch upstream
```

Expand Down Expand Up @@ -92,5 +92,5 @@ In general, changesets are not needed for the documentation, build utilities or

For more information, checkout [adding a changeset](https://github.com/atlassian/changesets/blob/master/docs/adding-a-changeset.md) documentation in the changesets repository.

[fork]: https://github.com/kurtaking/backstage-plugin-announcements/fork
[fork]: https://github.com/procore-oss/backstage-plugin-announcements/fork
[commit-message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Procore

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion docs/latest-announcement-banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Adding the `NewAnnouncementBanner` component to a page will display a banner wit
**Note:** if there are no announcements or the latest announcement has already been seen by the user, nothing will be displayed.

```ts
import { NewAnnouncementBanner } from '@kurtaking/backstage-plugin-announcements';
import { NewAnnouncementBanner } from '@procore-oss/backstage-plugin-announcements';

export const HomePage = () => {
return (
Expand Down
2 changes: 1 addition & 1 deletion docs/latest-announcements-on-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Adding the `AnnouncementsCard` component to a page will display a Card with the
Announcements yet unseen by the user will be prefixed by a specific icon.

```ts
import { AnnouncementsCard } from '@kurtaking/backstage-plugin-announcements';
import { AnnouncementsCard } from '@procore-oss/backstage-plugin-announcements';

export const HomePage = () => {
return (
Expand Down
4 changes: 2 additions & 2 deletions docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Enable announcements indexing in the search engine:

```typescript
// packages/backend/src/plugins/search.ts
import { AnnouncementCollatorFactory } from '@kurtaking/backstage-plugin-announcements-backend';
import { AnnouncementCollatorFactory } from '@procore-oss/backstage-plugin-announcements-backend';

export default async function createPlugin({
logger,
Expand Down Expand Up @@ -65,7 +65,7 @@ Nicely display announcements search results:
```typescript
// packages/app/src/components/search/SearchPage.tsx

import { AnnouncementSearchResultListItem } from '@kurtaking/backstage-plugin-announcements';
import { AnnouncementSearchResultListItem } from '@procore-oss/backstage-plugin-announcements';
import RecordVoiceOverIcon from '@material-ui/icons/RecordVoiceOver';

// ...
Expand Down
8 changes: 4 additions & 4 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Add the plugin to your backend app:

```bash
cd packages/backend && yarn add @kurtaking/backstage-plugin-announcements-backend
cd packages/backend && yarn add @procore-oss/backstage-plugin-announcements-backend
```

Create a file in `packages/backend/src/plugins/announcements.ts`:
Expand All @@ -14,7 +14,7 @@ Create a file in `packages/backend/src/plugins/announcements.ts`:
import {
buildAnnouncementsContext,
createRouter,
} from '@kurtaking/backstage-plugin-announcements-backend';
} from '@procore-oss/backstage-plugin-announcements-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';

Expand Down Expand Up @@ -56,14 +56,14 @@ async function main() {
Add the plugin to your frontend app:

```bash
cd packages/app && yarn add @kurtaking/backstage-plugin-announcements
cd packages/app && yarn add @procore-oss/backstage-plugin-announcements
```

Expose the announcements page:

```ts
// packages/app/src/App.tsx
import { AnnouncementsPage } from '@kurtaking/backstage-plugin-announcements';
import { AnnouncementsPage } from '@procore-oss/backstage-plugin-announcements';

// ...

Expand Down
Loading

0 comments on commit 5e95333

Please sign in to comment.