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

Update banner to match new designs and add analytics notification #2132

Merged
merged 29 commits into from
May 24, 2023

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented May 18, 2023

Fixes

Fixes #823 by @dhruvkb

Description

Note
This PR targets #2117 i.e. banner-style-refresh and not main.

This PR

  • updates the VNotificationBanner component to support
    • 4 natures (info, warning, success, error)
    • 2 variants (regular, dark)
  • adds 4 natures x 2 variants x 2 breakpoints = 16 stories for these
  • updates existing banners to use these new designs
  • adds a banner for the analytics
  • adds VRT for these Storybook stories
  • updates existing VRTs to pass with the additional banner
  • adds new icon assets (These are not a 1:1 match because some icons are not in the WP DL, requesting @fcoveram to provide)

Testing Instructions

You can directly refer to updated snapshots in the "Files changed" tab. Or you can do the following:

  1. Check out the PR and run the dev server.
  2. Clear all cookies.
  3. Visit http://localhost:8443/hi/?referrer=creativecommons.org
  4. You should see all three banners in the dark variant.
    Openly Licensed Images, Audio and More | Openverse

  1. Visit http://localhost:8443/hi/about/?referrer=creativecommons.org
  2. You should all all three banners in the regular variant.
    About Openverse | Openverse

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend labels May 18, 2023
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label May 18, 2023
@github-actions
Copy link

github-actions bot commented May 18, 2023

Size Change: +1.59 kB (0%)

Total Size: 846 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 127 kB +587 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 118 kB +640 B (+1%)
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB -13 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.7 kB +14 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.3 kB +154 B (+1%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.3 kB +153 B (+1%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.9 kB +62 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/234.js 272 B 0 B
./frontend/.nuxt/dist/client/234.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/235.js 1.85 kB -1 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB -3 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.61 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 768 B -1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.75 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.34 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.27 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.22 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 686 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 692 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 529 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.85 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.69 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 912 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.14 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.09 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 798 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.61 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 377 B +2 B (+1%)
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.88 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 891 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 894 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.55 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.92 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.91 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.67 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.96 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB +6 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.79 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 642 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 648 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 846 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 739 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 827 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 835 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 996 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.js 814 B -3 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 815 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.29 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 1.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.1 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.82 kB -6 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.18 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 619 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.89 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.76 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.22 kB +5 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.04 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.95 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB -4 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.59 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.69 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.58 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 544 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 548 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 446 B -2 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 242 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB +2 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.71 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB +8 B (0%)

compressed-size-action

@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/2132

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@github-actions github-actions bot added the 🧱 stack: mgmt Related to repo management and automations label May 19, 2023
@dhruvkb dhruvkb removed 🧱 stack: mgmt Related to repo management and automations 🧱 stack: documentation Related to Sphinx documentation labels May 19, 2023
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label May 19, 2023
@dhruvkb
Copy link
Member Author

dhruvkb commented May 19, 2023

Drafted and blocked awaiting the right icons and exact colors.

@dhruvkb dhruvkb linked an issue May 19, 2023 that may be closed by this pull request
Base automatically changed from banner-style-refresh to main May 19, 2023 14:17
@dhruvkb dhruvkb marked this pull request as ready for review May 23, 2023 14:14
@dhruvkb dhruvkb removed the ⛔ status: blocked Blocked & therefore, not ready for work label May 23, 2023
@zackkrida
Copy link
Member

@sarayourfriend requesting your review here as I don't think @fcoveram has the capacity to look at this PR this week.

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

@dhruvkb can you update this to make enable analytics by default in production, as mentioned in #2173?

@sarayourfriend
Copy link
Collaborator

I'll review this today or tomorrow.

Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM, works and looks great locally and on my relatively low-spec Android phone.

We should keep in mind the banner stacking and probably consider avoiding adding any more... Even two feels like a lot and will now be a common occurrence for folks visiting certain translations. At least the case with three is impossible to reach organically, right? CC search doesn't redirect any of our language prefixes as far as I can tell in my brief testing.

@dhruvkb
Copy link
Member Author

dhruvkb commented May 24, 2023

@sarayourfriend you're right, while 3 is the theoretical maximum, 2 is the most that will occur in practice. CC Search does not redirect to our localised pages.

Even then, we need to be conscious about adding any more banners in the future, or finding an alternative UI to display notifications (other than banners) if there is a need to add any new ones.

@dhruvkb dhruvkb merged commit 01d04fe into main May 24, 2023
@dhruvkb dhruvkb deleted the new_banner_designs branch May 24, 2023 09:17
@fcoveram
Copy link
Contributor

Thanks for the work @dhruvkb, and @sarayourfriend and @zackkrida for reviewing it.

Even then, we need to be conscious about adding any more banners in the future, or finding an alternative UI to display notifications (other than banners) if there is a need to add any new ones.

+100.

To this point, the best approach is to include notifications and any other similar feedback during the search experience or in context, like in the playing audio message when focusing on the component. We should avoid thinking of "adding a banner" as a first solution each time we need to convey information.

That degrades UX and product quality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Create the analytics notification
4 participants