feat: remove CTA

[asadali145]

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:

After:

[openedx-webhooks]

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8809f4c) to head (31629af).

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #347   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          111       109    -2     
  Lines         1082      1079    -3     
  Branches       160       158    -2     
=========================================
- Hits          1082      1079    -3     

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

[asadali145]

@jansenk Would you be able to review this PR?

[asadali145]

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

[brian-smith-tcril]

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]

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]

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

That would be wonderful @asadali145! Thank you!

[asadali145]

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

[awais-ansari]

Please follow the eslint recommendations. Other than PR LGTM.

[brian-smith-tcril]

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]

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.