nextflow icon indicating copy to clipboard operation
nextflow copied to clipboard

Update bin, lib, template docs

Open christopher-hakkaart opened this issue 11 months ago • 3 comments

Draft, do not merge.

christopher-hakkaart avatar Dec 03 '24 15:12 christopher-hakkaart

Deploy Preview for nextflow-docs-staging ready!

Name Link
Latest commit 0b9c83fff664359dd36adcda8df5795605328bbb
Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/67508fe5ee25940008d790f8
Deploy Preview https://deploy-preview-5564--nextflow-docs-staging.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Dec 03 '24 15:12 netlify[bot]

I'm not entirely sold on this, but let's see where you take it.

In other words, I'm not sure it's worth having an entire page dedicated to project-level bin/lib/templates when we are trying to encourage people to use module directories. And in the long-term, trying to move people away from the lib directory in favor of nextflow scripts and custom plugins.

But if this page can absorb other concepts related to project structure, e.g. from the CLI and sharing pages, it might be worthwhile

bentsherman avatar Dec 04 '24 16:12 bentsherman

Hmmm, yeah, good point.

I'm not completely committed to a whole "Project structure" page, but I think we do need to describe what project-level bin/lib/templates are and how to use them. It might be a good place to mention main.nf and nextflow.config too. Alternatively, I'd be fine with blending this into another page, I'm just not sure which one.

Either way, I'll modify the text to push developers to module-level module and template directories, and away from the lib directory in favor of nextflow scripts and custom plugins.

christopher-hakkaart avatar Dec 04 '24 17:12 christopher-hakkaart