nf-core / nf-core/website

Use OpenGraph rendering on pipeline pages

Open
#247 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

If we have a social media preview image on the GitHub repo, we should be able to use this on the nf-co.re web page as well. The pipeline health page already finds these, so it’s just a case of finding (and caching?) them, then sticking them in the head

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 how the pipeline health page finds social preview images, then trace the pipeline page rendering and its head handling. Determine where the repository OpenGraph image should be found and whether caching is needed; done means the image is included in the pipeline page's head and the behavior is verified.

Written by the indexing model from the issue text.

Assessment

Domain
frontend, web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.