Skip to content

Conversation

@MaxFrank13
Copy link
Member

This updates hardcoded links to instead use their corresponding configuration values. The hardcoded values were only relevant for 2u/edX

@MaxFrank13 MaxFrank13 changed the title Mfrank/remove 2u specific links fix: emove 2u specific links Nov 14, 2025
@codecov
Copy link

codecov bot commented Nov 14, 2025

Codecov Report

❌ Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 68.13%. Comparing base (4c94989) to head (a5cd803).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
src/index.jsx 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1377      +/-   ##
==========================================
- Coverage   68.25%   68.13%   -0.12%     
==========================================
  Files         120      120              
  Lines        2372     2376       +4     
  Branches      656      657       +1     
==========================================
  Hits         1619     1619              
- Misses        707      711       +4     
  Partials       46       46              

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

@sarina
Copy link
Contributor

sarina commented Nov 17, 2025

@MaxFrank13 - do operators have to supply their own links, or could we have some default links that point at docs.openedx.org?

@MaxFrank13 MaxFrank13 changed the title fix: emove 2u specific links fix: remove 2u specific links Nov 17, 2025
@MaxFrank13
Copy link
Member Author

could we have some default links that point at docs.openedx.org?

We certainly could! But I'm not sure those links exist in docs.openedx.org. For example, the email confirmation link is supposed to lead to a user facing page. I don't believe such a page exists in docs.openedx.org. I could be wrong though!

My understanding is that docs.openedx.org is more for operators than it is for users. And all of these links are for users (ie. email confirmation, account basics, learner support, etc.) so I think requiring operators to provide the links via configuration makes the most sense.

@sarina
Copy link
Contributor

sarina commented Nov 18, 2025

We have a learner's guide, and can always create new pages. I think it's better to have some default, rather than broken links, unless the broken links are hidden from the UI if they aren't defined.https://docs.openedx.org/en/latest/learners/index.html

ETA: We also have an Educator's guide, which is comprehensive. This is often useful for Studio or Inst Dash links. https://docs.openedx.org/en/latest/educators/index.html

@MaxFrank13
Copy link
Member Author

We have a learner's guide, and can always create new pages. I think it's better to have some default, rather than broken links, unless the broken links are hidden from the UI if they aren't defined.https://docs.openedx.org/en/latest/learners/index.html

The learner's guide is great. And I agree having defaults would be good. It looks like:

  • the index page can probably be linked to for the ACCOUNT_BASICS URL and perhaps it could work for the LEARNER_SUPPORT URL as well
  • for the Certificates, I can do https://docs.openedx.org/en/latest/learners/SFD_content_availability.html#view-certificate-status
  • the only one I'm not sure about is email confirmation as that doesn't seem to have a corresponding page in the learner's guide -- could maybe also default to index so that it's not broken?

Making them hidden is certainly an option but then we are changing the behavior which feels like it might be out of scope when the main goal here was to eliminate some org specific code. That may also require input from other stakeholders? What are your thoughts?

@sarina
Copy link
Contributor

sarina commented Nov 21, 2025

Sorry for the late reply. I agree with your proposed defaults. Thanks!

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