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

feat: remove CTA #347

Conversation

asadali145
Copy link
Contributor

@asadali145 asadali145 commented Aug 20, 2024

Relevant Tickets

#360

Description:

The CTA was added two years ago. It is enabled by default, and the notification is always visible. This PR removes the CTA. If we still need it, we can put it behind a flag.

Screen Shots:

Before:
Screenshot 2024-08-20 at 1 26 05 PM

After:
Screenshot 2024-10-02 at 12 33 20 PM

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 20, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @asadali145!

What's next?

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

🔘 Get product approval

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

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 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.

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

Who will review my changes?

This repository is currently maintained by @openedx/openedx-unmaintained. Tag them in a comment and let them know that your changes are ready for review.

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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

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

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from 730cebf to 32e356a Compare August 20, 2024 09:11
Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7ad1df8) to head (5d53592).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #347   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          111       109    -2     
  Lines         1088      1085    -3     
  Branches       166       165    -1     
=========================================
- Hits          1088      1085    -3     

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

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from bf6cc32 to 4c884d6 Compare September 5, 2024 09:56
@asadali145
Copy link
Contributor Author

@jansenk Would you be able to review this PR?

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from 4c884d6 to 056f661 Compare September 24, 2024 12:51
@asadali145 asadali145 requested review from brian-smith-tcril and removed request for arbrandes, jansenk and awais-ansari September 24, 2024 12:51
@asadali145
Copy link
Contributor Author

@brian-smith-tcril Would you be able to review this PR?

@brian-smith-tcril
Copy link
Contributor

Looking at this PR raises a few questions for me:

  • Do we want to remove the CTA?
  • Do we want to completely remove the notification banner if “preferences center” would be a broken link?
    • This effectively turns ACCOUNT_SETTINGS_URL into a "show/hide" notification banner toggle which seems less than ideal.
  • Do we need the notification banner at all?

My feeling is both the CTA and notification banner should just be removed completely. This would require going through the deprecation process.

Would fully removing both the notification banner and the CTA solve the problem you're trying to solve with this PR?

@asadali145
Copy link
Contributor Author

asadali145 commented Sep 25, 2024

Would fully removing both the notification banner and the CTA solve the problem you're trying to solve with this PR?

@brian-smith-tcril Yes, removing both solves our problem. We don't want to display the banners all the time.

Thanks for reviewing the PR. Do you want me to start the depreciation process for these banners?

@brian-smith-tcril
Copy link
Contributor

Do you want me to start the depreciation process for these banners?

That would be wonderful @asadali145! Thank you!

@asadali145
Copy link
Contributor Author

asadali145 commented Oct 1, 2024

@brian-smith-tcril I have created this DEPR ticket #360. Do you have any suggestions?

[EDIT]: I also posted the question in the Open edX Slack to confirm the usage of the notifications banner.

@@ -6,7 +7,8 @@ import { PageBanner, Hyperlink } from '@openedx/paragon';

import messages from './messages';

export const NotificationsBanner = () => (
// eslint-disable-next-line no-confusing-arrow
Copy link
Contributor

Choose a reason for hiding this comment

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

Please follow the eslint recommendations. Other than PR LGTM.

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.

I still think the best path forward for this would be to deprecate and fully remove both the CTA and notifications banner. If that isn't the direction we end up going I still do not approve of the way this is implemented.

  • I don't believe using ACCOUNT_SETTINGS_URL to determine if the notifications should appear or not is a good pattern. One other solution that comes to mind would be showing a different string without a link when ACCOUNT_SETTINGS_URL is not set.

Also, now that there seems to be more discussion around how we want to handle this, I believe it would be best to split this PR up. There should be one for removing the CTA, and one for modifying the notifications banner. That will allow the discussions to be targeted, and blockers for one won't get in the way of the other.

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from 056f661 to 31629af Compare October 2, 2024 07:22
@asadali145 asadali145 changed the title feat: remove cta and hide notifications banner if no accounts url feat: remove CTA Oct 2, 2024
@asadali145
Copy link
Contributor Author

Thanks @brian-smith-tcril and @awais-ansari. I have updated this PR to remove the CTA. I'll create a new PR to update the notifications banner. I have updated the DEPR ticket as well.

@asadali145
Copy link
Contributor Author

asadali145 commented Oct 7, 2024

@brian-smith-tcril Just a reminder that this PR needs review along with #362 as discussed to create separate PRs.

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.

Let's merge it! (context on DEPR approval #360 (comment))

@asadali145
Copy link
Contributor Author

@brian-smith-tcril Thanks for approval. I do not have merge access. Please merge it if you can OR I can ask someone else to merge this.

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from 31629af to e932614 Compare November 4, 2024 16:53
@asadali145
Copy link
Contributor Author

@brian-smith-tcril I have rebased this one as well.

@brian-smith-tcril
Copy link
Contributor

@asadali145 sorry I missed this! It looks like it needs another rebase. I've communicated my intention to merge, so as soon as it is rebased I'll hit the button.

@asadali145 asadali145 force-pushed the asad/remove-cta-hide-notifications-if-no-accounts-url branch from e932614 to 5d53592 Compare November 5, 2024 06:37
@asadali145
Copy link
Contributor Author

@brian-smith-tcril This is rebased. You can merge.

@brian-smith-tcril brian-smith-tcril merged commit 1f729be into openedx:master Nov 5, 2024
6 checks passed
@feanil feanil mentioned this pull request Nov 7, 2024
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
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants