learningequality / learningequality/studio

Improve errors reporting before publish

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

Nobody has claimed this yet.

P1 - important TAG: ux update
Dominant language
Python
Stars
191
Forks
307
Avg merge
5d 6h
Merged PRs (30d)
10

Description

Summary

This is how we currently report problems before publishing a channel:

Screenshot from 2021-02-10 11-24-04

If users want to fix them, they need to close the publish modal and locate all problematic resources themselves. That might be a frustrating experience, especially for larger channels that require scrolling or have many nested topics.

We'd like to report errors in a more granular way and also link to resources that need to be fixed directly.

Real-life consequences

Much faster and comfortable errors correction and publishing.

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 the publish modal and the resource and nested-topic navigation described in the issue. Determine how pre-publish problems are currently presented, then define the granular error links and their destinations. Done means users can identify and open each problematic resource without closing the modal.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.