openedx / frontend-component-header

GNU Affero General Public License v3.0
7 stars 123 forks source link

feat: configureable header links #475

Open asadali145 opened 7 months ago

asadali145 commented 7 months ago

Issue

https://github.com/openedx/platform-roadmap/issues/349

Description

Makes header links, labels, and User name display more customizable using the configurations.

Testing

Screenshots

Screenshot 2024-03-29 at 5 34 39 PM
openedx-webhooks commented 7 months ago

Thanks for the pull request, @asadali145!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

:radio_button: Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

:radio_button: Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

codecov[bot] commented 7 months ago

Codecov Report

Attention: Patch coverage is 93.75000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 67.71%. Comparing base (45246ad) to head (35287fc). Report is 3 commits behind head on master.

:exclamation: Current head 35287fc differs from pull request most recent head d5227d4. Consider uploading reports for the commit d5227d4 to get more accurate results

Files Patch % Lines
src/Header.jsx 88.88% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #475 +/- ## ========================================== - Coverage 70.67% 67.71% -2.96% ========================================== Files 24 24 Lines 358 350 -8 Branches 90 88 -2 ========================================== - Hits 253 237 -16 - Misses 103 111 +8 Partials 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mphilbrick211 commented 6 months ago

Hi @asadali145! Would you mind resolving the branch conflicts while I look for someone to review for you? Thanks!

asadali145 commented 6 months ago

@mphilbrick211 This should be good for a review now.

asadali145 commented 5 months ago

@arbrandes What are your thoughts on this PR? It is similar to the footer PR https://github.com/openedx/frontend-component-footer/pull/403 related to https://github.com/openedx/platform-roadmap/issues/324

arbrandes commented 1 month ago

@asadali145, the latest on this is that we'll be addressing header configurability as part of the OEP-65/Module Federation work. For the most part, it will be done as proposed here:

https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4412243977/Proposal+Customizable+Header+for+LMS

In the meantime, we're also adding PluginSlots to the header, such as this one.

https://github.com/openedx/frontend-component-header/pull/528

The slots should be ready by Sumac.

pdpinch commented 4 weeks ago

@asadali145 should we pursue this via the header pluginslot instead of configuration settings?

asadali145 commented 4 weeks ago

@asadali145 should we pursue this via the header pluginslot instead of configuration settings?

@pdpinch I don't think there is much that I can do at the moment per this comment on my footer PR

davidjoy commented 3 weeks ago

My recommendation would be for us to add plugin slots to the header/footer to support customization use cases for now, I think @brian-smith-tcril is helping with this effort.

As the comment @asadali145 linked mentions, we're working on a longer-term version of the header and footer which will support more customization through simple configuration. That's taking some time to get right, and won't be available for a while. Certainly not by Sumac, maybe by Teak.