iodide-project / iodide-project/iodide
Notebooks should have enough metadata to generate "featured notebooks" section on front page
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.5k
- Forks
- 145
- PR merge metrics
- No merged PRs in 30d
Description
This implies the following pieces of metadata added to the notebook model (https://github.com/iodide-project/iodide/blob/75787f7842b2df25c3ce5581586f51eb293f420c/server/notebooks/models.py#L6):
- An "avatar" field (a reference to an uploaded image, animated or otherwise), may be null
- A field indicating whether the notebook is "featured" (default to false, settable to true only inside admin interface for now)
- A field indicating the featured "priority" (indicating in which order it is to be displayed on the front page)
These fields should be enough to generate a featured notebook on the front page of the iodide server. Bonus: this should work well for our internal server.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with server/notebooks/models.py at the notebook model definition and inspect how notebook metadata is used for the front page and admin interface. Done means the model has nullable avatar, featured, and featured-priority metadata with the stated defaults and constraints, sufficient to generate the featured notebooks section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100