openedx/openedx-platform

Too many console warnings

Open

#32,888 opened on Aug 1, 2023

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Python (4,331 forks)auto 404
epichelp wantedmaintenance

Repository metrics

Stars
 (8,150 stars)
PR merge metrics
 (PR metrics pending)

Description

Many warnings routinely get logged when doing console operations in edx-platform. This is especially visible when provisioning a devstack installation (although the problem isn't limited to devstack). These warnings often indicate latent problems with the code that will cause headaches when attempting future upgrades, they distract developers when looking for the root cause of a problem, and some cause a disproportionate amount of log clutter because they reappear every time a management command is called. We should clean up as many of these as practical to improve the developer experience when working with the repository.

A/C:

  • Enumerate all the warnings that appear when provisioning lms & cms in devstack (ideally also noting the number of times each one appears).
  • Create a separate GitHub Issue in this repository to resolve each warning. They should get the "maintenance" and "help wanted" labels.
  • Create a tasklist in this issue collecting all the created issues.

Tasks

Contributor guide

Research direction
Examine provisioning logs from GitHub Actions to enumerate warnings, then create separate GitHub issues for each warning in the appropriate repositories.
Tech stack
python
Domain
backend
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65