openedx / openedx/openedx-core

Django settings cleanup: `AUTHORING_API_URL`, `OPENEDX_LEARNING`

Open
#481 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10
Forks
32
Avg merge
2d 17h
Merged PRs (30d)
12

Description

Settings should be named correctly documented using code annotations.

Might need to have some backcompat code to keep support for the old setting name for 1 release.

I'm not clear if AUTHORING_API_URL is actually used. If it's not, we should remove it.

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

Search the Django settings definitions and references for AUTHORING_API_URL and OPENEDX_LEARNING, starting by confirming whether AUTHORING_API_URL is used. Determine the correct annotated names and whether one release of backward compatibility is required; the work is done when obsolete naming is handled consistently and the settings are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.