Skip to content

Bug-1948879: Add links to docs and source in the Banner#995

Open
moijes12 wants to merge 8 commits intomozilla:mainfrom
moijes12:bug1948879
Open

Bug-1948879: Add links to docs and source in the Banner#995
moijes12 wants to merge 8 commits intomozilla:mainfrom
moijes12:bug1948879

Conversation

@moijes12
Copy link
Contributor

@moijes12 moijes12 commented Jan 29, 2026

Background

We have Bug-1948879 requesting links to the documentation for PerfCompare. Also, we need to remove the Banner in the PerfCompare page header.

Changes done in this PR

  • Added theme aware links to Docs, GitHub Source, Matrix and Bugzilla in the same row as the Dark Mode toggle button. The font style has been kept identical to the Dark Mode button label to ensure a consistent UX.
  • The Banner has been removed. The related components have also been removed.
  • Tests for App.tsx have been updated to check the new links and their tooltips

Fixes Bug-1948879

@netlify
Copy link

netlify bot commented Jan 29, 2026

Deploy Preview for mozilla-perfcompare ready!

Name Link
🔨 Latest commit 5a3c286
🔍 Latest deploy log https://app.netlify.com/projects/mozilla-perfcompare/deploys/69a69f639e049b0008ea934e
😎 Deploy Preview https://deploy-preview-995--mozilla-perfcompare.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@moijes12 moijes12 marked this pull request as draft January 29, 2026 15:04
@moijes12 moijes12 marked this pull request as ready for review January 29, 2026 15:18
@moijes12 moijes12 marked this pull request as draft January 29, 2026 15:18
@moijes12
Copy link
Contributor Author

@kala-moz I did run npm run fix-all and the tests run locally. Is there anything I need to do to fix it?

@codecov
Copy link

codecov bot commented Feb 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.47%. Comparing base (4b96368) to head (5a3c286).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #995   +/-   ##
=======================================
  Coverage   96.46%   96.47%           
=======================================
  Files         104      105    +1     
  Lines        3028     3034    +6     
  Branches      694      695    +1     
=======================================
+ Hits         2921     2927    +6     
  Misses        106      106           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@moijes12 moijes12 marked this pull request as ready for review February 1, 2026 17:40
Copy link
Contributor Author

@moijes12 moijes12 left a comment

Choose a reason for hiding this comment

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

@kala-moz The tests have been fixed and this can now be reviewed

@gmierz
Copy link
Contributor

gmierz commented Feb 2, 2026

@moijes12 as julien mentioned in the bug, we should wait for padenot to respond with what he expects to see how we should resolve the bug.

@moijes12
Copy link
Contributor Author

moijes12 commented Feb 3, 2026

@moijes12 as julien mentioned in the bug, we should wait for padenot to respond with what he expects to see how we should resolve the bug.

Thanks @gmierz . I will move this PR to draft till we finalize the requirement.

@moijes12 moijes12 marked this pull request as draft February 3, 2026 05:06
@kala-moz
Copy link
Contributor

@moijes12 Can we move this out of drafts? Paul has responded to the bug, saying he'll be fine with whatever the team chooses to do. For now, that's putting the link to the docs in the top banner.

@moijes12 moijes12 marked this pull request as ready for review February 19, 2026 10:55
@moijes12
Copy link
Contributor Author

@kala-moz I am moving this back for review. However, as per discussion on the PerfCompare channel, Greg had asked us to remove the banner completely and place the docs button near the mode toggle button.

@gmierz
Copy link
Contributor

gmierz commented Feb 20, 2026

@moijes12 I recommend making those changes to remove the banner and add docs under the toggle button to start and we can review the changes with all of that together.

Added links to PerfCompare docs and GitHub source in the Banner.
Added a shared `NavBarLink` component for the below:
- Docs
- Contact
- Source
@moijes12 moijes12 marked this pull request as draft February 27, 2026 12:57
@moijes12
Copy link
Contributor Author

moijes12 commented Feb 27, 2026

@gmierz @kala-moz I am working on udpdating the main page. Below is a screenshot (this is being refined further)

image

Please feel free to provide your views on the screenshot so that I can make the changes accordingly ? Would you want me to use any particular text color etc. ? I will look into the code for more guidance on this. The Banner will eventually go away and I will make it optional so that it is displayed only if any message needs to be displayed.

Thanks for the opportunity :)

@moijes12
Copy link
Contributor Author

moijes12 commented Mar 1, 2026

@gmierz @kala-moz Below is an updated screenshot

image

Highlights:

  • Links added on same level as toggle button
  • Links have identical font style to toggle button label
  • Links have tooltip

I am currently working on removing the banner

moijes12 added 2 commits March 1, 2026 17:32
…the header

Made the below changes to add new links to urls that were previously in Banner
* Created a new NavBarLink component as a single reusable component for Links in the Header
* Updated the PerfCompareHeader component to add a new Box with NavBarLinks - Docs, Source, File Bug, Matrix
* Updated the Strings to contain the required strings for tooltip

The Link font styles are kept identical to the Dark Mode switch label styles to ensure a consistent UX.
The Link is also theme aware.
Made the below changes to remove the banner:
* Updated the PerfCompareHeader to remove the Banner in the `<Alert />` component
* Removed the `Banner` component
* Updated the tests for `App.tsx` to check for all links and their correct tooltip
@moijes12
Copy link
Contributor Author

moijes12 commented Mar 2, 2026

@gmierz @kala-moz I am moving this out of draft. The Banner has been removed in the latest commit. I still have to fix a failing test but in the meanwhile I will look forward to your inputs so that I can make changes and iterate faster.

image

@moijes12 moijes12 marked this pull request as ready for review March 2, 2026 08:39
Updated the tests for rendering page by:
* Made the test for checking heading more specific
* Checked for entire Perfcompare tagline text
Executed linter and updated snapshots
@moijes12
Copy link
Contributor Author

moijes12 commented Mar 3, 2026

@gmierz @kala-moz The tests have been fixed :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants