learningequality / learningequality/studio

Removal of the sample content in channel detailed pdf

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

Nobody has claimed this yet.

Dominant language
Python
Stars
191
Forks
307
Avg merge
5d 6h
Merged PRs (30d)
10

Description

Summary

In the Content Library page, when "Download a summary of selected channels" is used and the selected format is pdf a sample content of the channel is added to the pdf.
Creating these samples makes impossible to use one single sql query to generate the whole document, thus it makes impossible to use one single query to generate multiple channels information at once.

Could we remove this part or, at least, use a different api endpoint to create it? when csv is selected the info is not even used, but the data is generated.

Category

ENHANCEMENT

Usage Details

image

Related to #2272

After removing this part, multiple channels information could be created in one single database query, reducing both the executed code in the backend, in the frontend and network requests.

At worst, if we consider this is needed, we should be able to make one single request to retrieve all the channels info, and then one request per channel to get the samples.

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 from the Content Library flow for “Download a summary of selected channels” and trace how PDF and CSV exports retrieve channel details and samples. Done means sample content is no longer generated unnecessarily and selected channels can be handled through a single database query or the stated reduced-request alternative.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
api, backend, database, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.