-
Notifications
You must be signed in to change notification settings - Fork 4.2k
fix: remove unnecessary help urls tokens #37953
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
base: master
Are you sure you want to change the base?
Conversation
|
Thanks for the pull request, @DeimerM! 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. |
|
Hi @sarina, @felipemontoya , As part of the commitment made in PR #37493, I have created this PR to remove the tokens for which I couldn't find any references within the openedx organization repositories. |
|
@DeimerM thanks for this! Could you take a look at the failing tests? |
acadae0 to
31d7ada
Compare
|
@DeimerM I'm curious what it means when you've identified a token was used on "openedx-platform - legacy template" - does that mean that there are legacy templates that exist that still call these tokens? |
Yes @sarina, that's correct. An example can be found here, where the schedule token is called:
|
|
@DeimerM I'm wary about removing tokens that are still called in legacy pages, in case people are still using those legacy pages. I think we're safe to remove any tokens that are not being called at all in the platform, but for the ones that are still being called by legacy pages we should wait for the legacy pages to be removed. @feanil does that make sense? |
@sarina In this case, I am only removing the ones for which I found no references at all in the platform; for those that are still being called—even on legacy pages—I have left them intact. |
Description
This PR is intended to remove the help tokens that are no longer referenced within the Open edX repositories. Specifically, a search was conducted across the openedx organization to find references to the functionalities of the help tokens tool.
It is important to note that this PR is part of a commitment made in the following PR: #37493, where these tokens were updated to use articles from the official Open edX documentation.
Research Summary
After searching for these tokens across the openedx organization, we obtained the following results, which show the tokens that were found and the location (repository) where they were identified:
The criteria used for removal was straightforward: any token not found referenced within a repository was marked for deletion.