Skip to content
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.

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

implement pushfeedback #3837

Merged
merged 9 commits into from
Jul 24, 2024
Merged

implement pushfeedback #3837

merged 9 commits into from
Jul 24, 2024

Conversation

christinaausley
Copy link
Contributor

Description

Option #2 for the PushFeedback widget -- relates to #355.

This option uses Swizzling to extend our footer, essentially:

Screenshot 2024-05-22 at 1 55 22 PM

And when a user clicks either the thumbs up or thumbs down they see:

Screenshot 2024-05-22 at 1 55 59 PM

This takes care of the location issues I was having in #3812, but I can't figure out how to customize the pop-up modal to adjust its coloring and such. Thoughts @pepopowitz?

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added the hold This issue is parked, do not merge. label May 22, 2024
@christinaausley christinaausley self-assigned this May 22, 2024
@christinaausley christinaausley marked this pull request as draft May 22, 2024 17:57
@akeller
Copy link
Member

akeller commented May 24, 2024

Since we have the Ask AI button, this is my preferred integration. Let's chat more on our internal devex channel about next steps @christinaausley.

@akeller
Copy link
Member

akeller commented Jun 6, 2024

🟢 This gets my stamp of approval (and, for internal purposes, your line manager's stamp of approval).

@christinaausley will work through the vendor/new tool process internally. Thanks for getting this rolling!

@christinaausley christinaausley changed the title pushfeedback option 2 implement pushfeedback Jun 10, 2024
@christinaausley christinaausley marked this pull request as ready for review July 23, 2024 15:33
@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team and removed hold This issue is parked, do not merge. labels Jul 23, 2024
@christinaausley
Copy link
Contributor Author

This is ready for final review @pepopowitz @akeller 👍

@akeller akeller added the deploy Stand up a temporary docs site with this PR label Jul 23, 2024
@akeller
Copy link
Member

akeller commented Jul 23, 2024

Adding deploy tag to help with review.

Copy link
Contributor

github-actions bot commented Jul 23, 2024

🧹 Preview environment for this PR has been torn down.

@github-actions github-actions bot temporarily deployed to camunda-docs July 23, 2024 17:26 Destroyed
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

This is awesome!!!! Great work!!

The only blocking request I have is that we add some information about why we are swizzling this component. I also added some comments related to a non-blocking styling nit.

I will also mention that I was unable to submit feedback through the preview site, with a message from PushFeedback that it was coming from a URL that they didn't recognize. I assume this will all just work when we go live, submitting feedback from the docs.camunda.io URL.

src/theme/DocItem/Footer/index.js Show resolved Hide resolved
src/theme/DocItem/Footer/index.css Show resolved Hide resolved
src/theme/DocItem/Footer/index.js Outdated Show resolved Hide resolved
src/theme/DocItem/Footer/index.js Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to camunda-docs July 23, 2024 21:12 Destroyed
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@christinaausley
Copy link
Contributor Author

Thank you @pepopowitz! 🥳

@github-actions github-actions bot temporarily deployed to camunda-docs July 23, 2024 21:38 Destroyed
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

No blocking concerns from me.

If possible, we may want to add stage.docs.camunda.io to the list of URLs PushFeedback allows so we can test this before it goes all the way live, but I'm also fine with testing in production and removing it if we see anything concerning. YOLO

Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

❤️ ❤️ ❤️

@christinaausley
Copy link
Contributor Author

We can only set one domain per "project" with PushFeedback, so I'm going to ship this. If anything wonky pops up I'll backtrack and create a new project with the staging domain to test more thoroughly.

@christinaausley christinaausley merged commit 218dc7b into main Jul 24, 2024
8 checks passed
@christinaausley christinaausley deleted the pushfeedback-react branch July 24, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants