nf-core / nf-core/website

Publications: Use component and require only a DOI

Open
#2,729 1 comment 0 reactions 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

The publications page currently uses markdown which is fine, but a bit verbose and a hassle to add publications to.

We should be able to retrieve all of the information that we need from a DOI alone, using crossref. We could have a new component that takes DOI as an argument and then updates a JSON cache if needed and renders everything else.

Could even just make it a python script that writes to a JSON file and then render the entire page automatically. Not sure we really need much / any markdown on this page.

I wrote something similar for my soon-to-be-published-honest-any-day-now personal website here.

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

Review the current publications page and the linked add_pub.py example first. Define how DOI-only entries should retrieve and cache Crossref metadata, then confirm that the page renders the required publication information automatically. Done means publications can be added with only a DOI and the generated page remains complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
content, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.