openedx / openedx/frontend-app-authoring

Remove "Help URLs" API usage

Open
#2,768 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
TypeScript
Stars
17
Forks
218
Avg merge
9d 20h
Merged PRs (30d)
20

Description

Remove all usage of the "help URLs" API as well as the API and data references. See https://github.com/openedx/frontend-app-authoring/pull/2714 for what this API is.

The help URLs API is deprecated: https://github.com/openedx/help-tokens/issues/260

It should be replaced with the external URLs API - see https://github.com/openedx/frontend-app-authoring/pull/2730

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing pull requests 2714 and 2730 to understand the help URLs and external URLs APIs, then search the repository for help URLs API and data references. Done means all help URLs API usage and references are removed and the external URLs API is used instead.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
api, frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.