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

Refactor announcements infoCard #89

Merged
merged 3 commits into from
Nov 16, 2023

Conversation

gaelgoth
Copy link
Contributor

@gaelgoth gaelgoth commented Oct 27, 2023

Here is my proposal for #77. The aim is to make something lighter and keep it on line with this infocard: https://github.com/procore-oss/backstage-plugin-announcements/blob/main/docs/images/announcements_card.png.

Here's what it looks like:
image

Depending on your feedback @kurtaking , I'll do that next:

@gaelgoth gaelgoth requested review from kurtaking and a team as code owners October 27, 2023 15:12
@gaelgoth gaelgoth marked this pull request as draft October 27, 2023 15:18
@kurtaking
Copy link
Member

I'm not the biggest fan of this existing page in general, and I have a long-term hope of separating concerns into two areas.

  1. Announcements / Newsfeed - where end users go to browse the latest announcements in a more social media newsfeed atmosphere. There are many opportunities to add functionality here, such as filtering by topic, read/unread, etc.

  2. Admin Panel - where admins can manage announcements (create, edit, update, delete). I want a user to have all of this functionality on a single page instead. You are currently taken through several different react components to create and edit announcements (and categories).

Here are some screenshots from exploratory work I've done. Someone can manage announcements and categories from a single view.

image image

and then some sort of scrollable newsfeed for end users

image

With all of that being said, I like the changes you are introducing to the existing components. Is it possible to move the edit menu to the top right of the card header? It looks like it's dangling at the end of the card with too much open space around it. Maybe something more similar to this?

@kurtaking kurtaking added the enhancement New feature or request label Oct 27, 2023
@gaelgoth
Copy link
Contributor Author

I like your idea @kurtaking to have clear/distinct views between announcements and admin. Is it also scheduled to support different levels of announcements like info, critical, ...? Regarding this PR, yes, I can adapt as you mentioned 👍🏾. Thanks for the insight into the future of this plugin.

@kurtaking
Copy link
Member

Is it also scheduled to support different levels of announcements like info, critical, ...?

Yeah, it can. I've talked to @drodil about this some, as they had this open PR for that functionality. We just need to get it merged in over here.

I also want to create the concept of campaigns that can handle more targeted announcements based on something.

For example, I want to be able to say, "Send this announcement to owners of components where type == API and label == something and X team is partOf Y division."

I plan to write up more formal issues on all of this in the near future.

@kurtaking
Copy link
Member

Hey @gaelgoth, the next release will include #105 which should help with local development. Our of curiosity, how are you currently populating local data for development?

@gaelgoth
Copy link
Contributor Author

gaelgoth commented Nov 8, 2023

Hey @gaelgoth, the next release will include #105 which should help with local development. Our of curiosity, how are you currently populating local data for development?

Hello @kurtaking 👋🏽,

Nice addition. Yes, I did it manually last time

@gaelgoth
Copy link
Contributor Author

gaelgoth commented Nov 8, 2023

Rebase branch

@gaelgoth gaelgoth force-pushed the refactor-announcements-card branch from f6fa329 to 977d9e6 Compare November 8, 2023 12:56
Copy link

changeset-bot bot commented Nov 8, 2023

🦋 Changeset detected

Latest commit: b4e929d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@procore-oss/backstage-plugin-announcements Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gaelgoth gaelgoth force-pushed the refactor-announcements-card branch from 977d9e6 to 9b95da2 Compare November 8, 2023 14:23
@gaelgoth
Copy link
Contributor Author

gaelgoth commented Nov 8, 2023

Hi @kurtaking,

I did the changes as requested 👍🏾

image

@gaelgoth gaelgoth marked this pull request as ready for review November 8, 2023 14:39
@gaelgoth gaelgoth force-pushed the refactor-announcements-card branch from 9b95da2 to 99a5edb Compare November 9, 2023 12:48
@kurtaking kurtaking self-assigned this Nov 10, 2023
@kurtaking
Copy link
Member

Hey @gaelgoth, I ran things locally, and the updates look great! Can you do one last thing and look for any screenshots that need to be updated? Looking forward to getting this merged.

@gaelgoth gaelgoth force-pushed the refactor-announcements-card branch from 428369e to 27e02ac Compare November 13, 2023 08:18
@gaelgoth gaelgoth force-pushed the refactor-announcements-card branch from 27e02ac to b4e929d Compare November 13, 2023 08:20
@gaelgoth
Copy link
Contributor Author

Hello @kurtaking,
Thank you for the review. I updated the screenshot.

Copy link
Member

@kurtaking kurtaking left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaelgoth looking good, thank you!

@Nereis
Copy link

Nereis commented Nov 14, 2023

Hi @kurtaking,

Since you are refactoring the views, I'll would suggest to integrate the excerpt (that I would rename to description or summary which are more common terms) in the detail of the announcement.

@kurtaking kurtaking merged commit 95c94c0 into procore-oss:main Nov 16, 2023
3 checks passed
@kurtaking
Copy link
Member

Hi @kurtaking,

Since you are refactoring the views, I'll would suggest to integrate the excerpt (that I would rename to description or summary which are more common terms) in the detail of the announcement.

Hey @Nereis, I saw you created an issue for this, correct? Happy to follow up there and get a separate PR going.

@gaelgoth gaelgoth deleted the refactor-announcements-card branch November 17, 2023 06:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants