Skip to content

Entity Feedback Plugin #15881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Feb 13, 2023
Merged

Entity Feedback Plugin #15881

merged 2 commits into from
Feb 13, 2023

Conversation

kuangp
Copy link
Member

@kuangp kuangp commented Jan 21, 2023

Signed-off-by: Phil Kuang pkuang@factset.com

New year, new plugin 🎉

Introducing the Entity Feedback plugin!

This simple plugin allows you to rate the quality of entities in your Backstage catalog. Why would you want to rate entities you ask? As a new adopter your first big hurdle might be building out your software catalog and ensuring your content is correct and up to date. Allowing your users to rate entities brings them into the feedback loop that can help notify owners if something is wrong with their entity (ie. taking inspiration of the feedback model of TechDocs 😁).

Screen.Recording.2023-01-20.at.10.47.07.PM.mov

Future Work / Enhancement Ideas

  • Additional rating types
  • Displaying historical data (rating changes over time)
  • Hooking up the permissions framework
  • Support for anonymous feedback
  • Cleaning up "orphaned rating data" from deleted entities
  • Incorporating rating data into ranking of entities in search results (this would be pretty cool)

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@kuangp kuangp requested review from a team and backstage-service as code owners January 21, 2023 04:25
@github-actions github-actions bot added the area:microsite Changes to backstage.io label Jan 21, 2023
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Jan 21, 2023 •
edited
Loading

Changed Packages

Package Name Package Path Changeset Bump Current Version
example-app packages/app none v0.2.80-next.2
example-backend packages/backend none v0.2.80-next.2
@backstage/plugin-entity-feedback-backend plugins/entity-feedback-backend minor v0.0.0
@backstage/plugin-entity-feedback-common plugins/entity-feedback-common minor v0.0.0
@backstage/plugin-entity-feedback plugins/entity-feedback minor v0.0.0

@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2023 •
edited
Loading

Uffizzi Preview deployment-14731 was deleted.

@kuangp kuangp force-pushed the feat/feedback-plugin branch from a67fbc0 to e1c1ff7 Compare January 21, 2023 04:46
@github-actions
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Jan 31, 2023
@kuangp
Copy link
Member Author

kuangp commented Jan 31, 2023

shoo stale bot 😠

@github-actions github-actions bot removed the stale label Jan 31, 2023
camilaibs
camilaibs reviewed Jan 31, 2023
View reviewed changes
Copy link
Contributor

@camilaibs camilaibs left a comment

Choose a reason for hiding this comment

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

I easily see the rate incorporated in the search results score 🤩

@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2023

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Feb 7, 2023
@kuangp
feat(entity-feedback): implement plugin
a3c86a7 
Signed-off-by: Phil Kuang <pkuang@factset.com>
@kuangp kuangp force-pushed the feat/feedback-plugin branch from e1c1ff7 to a3c86a7 Compare February 7, 2023 22:18
@kuangp kuangp requested a review from a team as a code owner February 7, 2023 22:18
@kuangp kuangp requested a review from freben February 7, 2023 22:18
@github-actions github-actions bot removed the stale label Feb 7, 2023
@Rugvip Rugvip self-requested a review February 9, 2023 16:15
Rugvip
Rugvip requested changes Feb 12, 2023
View reviewed changes
Copy link
Member

@Rugvip Rugvip left a comment

Choose a reason for hiding this comment

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

Sweet 😁 🎉

Loving the additions on top of 👍 / 👎 to make the feedback more valuable

Just some small nits.

Btw, do you mind adding yourself as codeowner of the packages as well? Just to keep track of it for now, but hopefully not too long now before it actually has an effect 😁 Will ofc ask again at that point

packages/app/src/components/catalog/EntityPage.tsx
@@ -374,6 +379,12 @@ const overviewContent = (
</EntitySwitch.Case>
</EntitySwitch>

<Grid item md={2}>
<InfoCard title="Rate this entity">
<LikeDislikeButtons />
Copy link
Member

Choose a reason for hiding this comment

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

Do you feel strongly about structuring it like this as opposed to exporting a EntityLikeDislikeCard? :>

Copy link
Member Author

Choose a reason for hiding this comment

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

so the motivation behind this is to allow it to be more customizable in where the consumer wants to render these buttons. eg. internally we created a custom AboutCard and put the buttons there (AFAIK the API for a customizable AboutCard is still unsettled so wasn't sure if I should include in the demo app in that manner as an example):

Screen Shot 2023-02-13 at 9 18 41 AM

Copy link
Member

Choose a reason for hiding this comment

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

yep figured x), yeah it's really quite a lot nicer to have it on the AboutCard. Perhaps it's even worth calling it out in the README? Alright, let's leave as is

plugins/entity-feedback-backend/package.json Outdated
@@ -0,0 +1,50 @@
{
"name": "@backstage/plugin-entity-feedback-backend",
"version": "0.1.0",
Copy link
Member

Choose a reason for hiding this comment

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

Should start out the packages at 0.0.0, then they'll get bumped to 0.1.0 on the first release

plugins/entity-feedback-common/src/index.ts Outdated
/**
* @public
*/
export interface Response {
Copy link
Member

Choose a reason for hiding this comment

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

Wonder if it might be better to call this FeedbackResponse or smth like tha?, there's some pretty direct overlap here 😅

@kuangp
chore(review): address comments
dfbe698 
Signed-off-by: Phil Kuang <pkuang@factset.com>
@kuangp kuangp force-pushed the feat/feedback-plugin branch from 8a6e715 to dfbe698 Compare February 13, 2023 15:12
@kuangp kuangp requested review from Rugvip and removed request for freben February 13, 2023 15:53
@kuangp
Copy link
Member Author

kuangp commented Feb 13, 2023

@Rugvip updated! thanks for taking the time to review!

Rugvip
Rugvip approved these changes Feb 13, 2023
View reviewed changes
Copy link
Member

@Rugvip Rugvip left a comment

Choose a reason for hiding this comment

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

Thank you! 😁

Let's :shipit: 🎉

@Rugvip Rugvip merged commit 402abac into backstage:master Feb 13, 2023
@github-actions
Copy link
Contributor

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.11.0 release, scheduled for Tue, 14 Feb 2023.

@benjdlambert benjdlambert mentioned this pull request Feb 14, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camilaibs camilaibs camilaibs left review comments

@Rugvip Rugvip Rugvip approved these changes

@backstage-service backstage-service Awaiting requested review from backstage-service backstage-service is a code owner

Assignees

@Rugvip Rugvip

@samiramkr samiramkr

Labels
area:microsite Changes to backstage.io
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kuangp @Rugvip @camilaibs @samiramkr