nextflow-io/nextflow

Add hyperlinks to HTML DAG

Open

#4,346 opened on Sep 26, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Groovy (3,382 stars) (784 forks)batch import
good first issuestale

Description

Now that the HTML DAG renders a mermaid diagram (#4316), we can extend it in some interesting ways:

Add hyperlinks to nodes

Process links to source code, operator links to operator docs, input files link to URL source. Adding the link is trivial. Determining what the link should be is not 😄

Anyway, could be a fun frontend project for someone who wants to try 😄

Contributor guide

Tech stack
htmlcssjavascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understand Nextflow HTML DAG renderingFamiliarity with Mermaid.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review PR #4316 to understand the current HTML DAG implementation. Look at the DAG rendering code to identify where node elements are generated. Then explore how to add href attributes to nodes based on source code links, operator docs, or input file URLs. The maintainer suggests linking process nodes to source code and operator nodes to docs. Check existing code for any URL patterns.