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

fix: get brand logo file path from env #205

Merged
merged 2 commits into from
Oct 12, 2023

Conversation

shahbaz-shabbir05
Copy link
Contributor

@shahbaz-shabbir05 shahbaz-shabbir05 commented Sep 8, 2023

Description:

While working on a project that involved customizing and testing a specific part of the system, I noticed a problem. The logo for this dashboard was fixed or hard-coded, which means it couldn't be easily changed or customized. To solve this issue, I made some changes in this PR.

Here's what I did in the PR:

  • I made a modification to the code so that the logo's URL is not fixed within the code but is instead fetched from an env file. This way, we can change the logo by simply updating the configuration file without having to edit the code itself.

Related Issues: #176 & https://github.com/mitodl/hq/issues/1806

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 8, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 8, 2023

Thanks for the pull request, @shahbaz-shabbir05! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@itsjeyd
Copy link

itsjeyd commented Sep 13, 2023

Hi @shahbaz-shabbir05, thank you for this contribution. Just to confirm, are the changes ready for review?

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Sep 13, 2023
@shahbaz-shabbir05 shahbaz-shabbir05 added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Sep 14, 2023
@shahbaz-shabbir05
Copy link
Contributor Author

Hi @shahbaz-shabbir05, thank you for this contribution. Just to confirm, are the changes ready for review?

Yes, the changes are ready for review.

@codecov
Copy link

codecov bot commented Sep 14, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (1478956) 96.46% compared to head (7e3df49) 96.46%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #205   +/-   ##
=======================================
  Coverage   96.46%   96.46%           
=======================================
  Files         195      195           
  Lines        1839     1839           
  Branches      322      322           
=======================================
  Hits         1774     1774           
  Misses         60       60           
  Partials        5        5           
Files Coverage Δ
src/config/index.js 100.00% <ø> (ø)
...rc/containers/LearnerDashboardHeader/BrandLogo.jsx 100.00% <ø> (ø)

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

@itsjeyd
Copy link

itsjeyd commented Sep 21, 2023

Thanks @shahbaz-shabbir05!

@mattcarter This PR is ready for engineering review by Aurora.

Copy link
Contributor

@cintnguyen cintnguyen left a comment

Choose a reason for hiding this comment

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

Tested locally, was able to rebase off of master with no conflicts. Tested with default settings and saw the default logo as expected. Tested manually by setting the environment variable (by running LOGO_URL=fake.jpg npm start) and saw broken brand logo image icon as expected.

@itsjeyd
Copy link

itsjeyd commented Oct 10, 2023

Hi @cintnguyen, thanks for the review! Do you know if we can consider your approval binding? I'm asking because as far as I can tell you're not part of the 2U team that owns this repo (Aurora), and I'm trying to understand if this PR will need a second review from that team before we can consider it ready for merge.

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

:shipit:

Copy link
Contributor

@mattcarter mattcarter left a comment

Choose a reason for hiding this comment

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

approved

@mattcarter mattcarter merged commit 82ff0d7 into openedx:master Oct 12, 2023
6 checks passed
@openedx-webhooks
Copy link

@shahbaz-shabbir05 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@itsjeyd itsjeyd removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 13, 2023
shahbaz-shabbir05 added a commit to shahbaz-shabbir05/frontend-app-learner-dashboard that referenced this pull request Nov 30, 2023
Co-authored-by: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com>
jsnwesson pushed a commit that referenced this pull request Nov 30, 2023
Co-authored-by: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

6 participants