Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bin, lib, template docs #5564

Draft
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

christopher-hakkaart
Copy link
Contributor

Draft, do not merge.

christopher-hakkaart and others added 20 commits December 2, 2024 11:52
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Adam Talbot <[email protected]>
Signed-off-by: adamrtalbot <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: jorgee <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Copy link

netlify bot commented Dec 3, 2024

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 0b9c83f
🔍 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.

docs/structure.md Outdated Show resolved Hide resolved
@bentsherman
Copy link
Member

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

@christopher-hakkaart
Copy link
Contributor Author

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.

Signed-off-by: Christopher Hakkaart <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants