learningequality / learningequality/studio

Visibility and management of sync and publishing channel operations in UI

Open
#3,718 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design: todo DEV: backend DEV: frontend TAG: user strings TODO: needs decisions
Dominant language
Python
Stars
191
Forks
307
Avg merge
5d 6h
Merged PRs (30d)
10

Description

Background

We recently introduced a new change event architecture in Studio. The architecture allowed us to process channel modifications and operations sequentially, and we incorporated channel syncing and publishing into the architecture. As a result, the following things came about:

  • We were no longer required to block the user from making edits to a channel during a sync or publishing, through the use of modals. The modals were removed and status tracking of syncing and publishing was integrated into the header
  • We no longer had a straightforward technical capability to cancel syncing and publishing operations, nor a place in the UI to surface that capability. The ability to stop those operations was removed.
Before After
Screenshot from 2022-10-05 11-56-17 Screenshot from 2022-10-05 11-57-04
Screenshot from 2022-10-05 11-59-20 Screenshot from 2022-10-05 10-32-38
Screenshot from 2022-10-05 12-14-04 Screenshot from 2022-10-05 12-13-02
Screenshot from 2022-10-05 12-01-22 No equivalent state

Potential issues/questions

  • Is it valuable to allow stopping these operations, even though the user isn't blocked from making further changes?
  • When publishing completes, the header will show "Published X minutes ago", but there isn't such information for the sync operation.

Considerations

  • We could likely allow the stopping of these operations with some backend work, if it's highly valuable to support it.
  • Would some sort of task manager design tracking the history of these operations make sense?
  • Would adding snackbars that appear on complete of at least the syncing operation satisfy the missing equivalent state?

References

https://github.com/learningequality/studio/issues/3710

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 reading issue 3710 and reviewing the before-and-after UI states linked here. The issue names no files or tests, so first determine whether cancellation, operation history, or completion feedback is in scope and locate the relevant Studio UI and backend entry points. Done requires an agreed behavior and implementation scope.

Written by the indexing model from the issue text.

Assessment

Domain
design, 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.