-
Notifications
You must be signed in to change notification settings - Fork 174
Add external links override support #2730
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
Add external links override support #2730
Conversation
|
Thanks for the pull request, @diana-villalvazo-wgu! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
Why aren't these URLs using the "help URL" API? We just did some refactoring of it in #2714 which is why I'm thinking about it, but it seems to be doing the exact same thing. |
@bradenmacdonald Not sure about that, we didn't introduced those links, i just took the work to wrap hardcoded links with that new function. Coming from this thread: https://openedx.slack.com/archives/C04BM6YC7A6/p1764789053939589?thread_ts=1763672859.489199&cid=C04BM6YC7A6 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2730 +/- ##
========================================
Coverage 94.92% 94.92%
========================================
Files 1238 1238
Lines 28426 28430 +4
Branches 6480 6291 -189
========================================
+ Hits 26983 26987 +4
- Misses 1372 1385 +13
+ Partials 71 58 -13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bradenmacdonald
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just one 404 issue to fix and then I think this is good.
| <Hyperlink | ||
| showLaunchIcon={false} | ||
| destination="https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/developing_course/course_components.html#components-that-contain-other-components" | ||
| destination={getExternalLinkUrl('https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/developing_course/course_components.html#components-that-contain-other-components')} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This docs URL was working before, but now seems to be a 404. Can we first replace it with a working URL? Perhaps https://docs.openedx.org/en/latest/educators/concepts/advanced_features/about_content_experiments.html ?
CC @sarina
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wgu-jesse-stewart
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work on this! The implementation is clean and consistent across all components. Documentation is thorough and will be helpful for operators wanting to customize external links. Consider adding a note in the docs that the URL list may be incomplete/is a snapshot in time. I also left an unrelated comment about a className typo, maybe we can fix it with this PR?
I ran grep to verify you've caught all the user-facing external documentation links and it looks like you caught everything. Everything else in the codebase is test mocks, code comments, or dynamic URLs.
Once the broken link is fixed (per @bradenmacdonald's comment), this should be good to merge!
8785e30 to
8127bc9
Compare
|
@diana-villalvazo-wgu Please fix the test that needs to be updated, and then I can merge. |
Description
Wrapped following links with
getExternalLinkUrlfunction so it can be modified by config.Supporting information
Closes #2729
Link to other information about the change, such as GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.
Testing instructions
Best Practices Checklist
We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:
.ts,.tsx).propTypesanddefaultPropsin any new or modified code.src/testUtils.tsx(specificallyinitializeMocks)apiHooks.tsin this repo for examples.messages.tsfiles have adescriptionfor translators to use.../in import paths. To import from parent folders, use@src, e.g.import { initializeMocks } from '@src/testUtils';instead offrom '../../../../testUtils'