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

[Docs] Workflow output: Include publish in example. #5274

Closed
wants to merge 1 commit into from

Conversation

ewels
Copy link
Member

@ewels ewels commented Sep 2, 2024

Closes #5273

[ci-skip]

@ewels ewels requested a review from a team as a code owner September 2, 2024 15:15
Copy link

netlify bot commented Sep 2, 2024

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 3df2c06
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/66d5d69d7d8e1b00089ab926
😎 Deploy Preview https://deploy-preview-5274--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.

Comment on lines 410 to 415
workflow {
foo(bar())

publish:
foo.out >> 'foo'
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to remove fake details? This way draws your attention to the output block which is the focus of the statement.

Suggested change
workflow {
foo(bar())
publish:
foo.out >> 'foo'
}
workflow {
// ...
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, but having it there does implicitly tell anyone skim-reading just this one section that nothing is going to happen without publish, which I quite like..

@bentsherman
Copy link
Member

I wouldn't bother with this, since this whole section will be re-vamped in the next month or two by #5185

@ewels ewels closed this Sep 4, 2024
@ewels ewels deleted the docs-workflow-publish branch September 4, 2024 14:20
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.

Clarify that you must use publish: to produce output files with new syntax
3 participants