-
Notifications
You must be signed in to change notification settings - Fork 636
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
Incorporate DSL2 features into docs #3793
Conversation
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work 👏🏻
Some minor suggested changes, though not sure of these are me commenting on the original docs that you've moved around. Big improvement though, thanks @bentsherman! 🚀
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
@pditommaso ready to merge? |
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
81f7cb7
to
8a43489
Compare
Signed-off-by: Ben Sherman <[email protected]>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Ben Sherman <[email protected]>
@pditommaso it would be good to merge this one before the 23.10 release, since DSL2 is now required, it will make the docs truly DSL2-first. It also refactors the DSL2 page into a DSL1 migration guide, so that there is still a reference for the old DSL1 syntax, and it is geared more towards migrating old DSL1 code. |
Signed-off-by: Ben Sherman <[email protected]>
@pditommaso can we please merge this before the stable release? |
I'll check asap |
I cannot build this. Does it require some changes in the sphinx container?
|
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Solved! 148a34b 😎 |
Nice job! 👍 |
Signed-off-by: Ben Sherman <[email protected]> Signed-off-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Phil Ewels <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]>
This PR moves the DSL2 features (functions, workflows, modules) into the main docs, since they are well-established language features now. The DSL2 page has been refactored into a "DSL1 migration guide" so that there are still some DSL1 examples, since the rest of the docs use DSL2 now and we don't maintain docs for older versions.
The sections on functions, workflows, and modules were mostly copy/paste into their own sections, with some minor edits for clarity.
These changes should be consistent with what we were planning anyway for the website overhaul, but I decided to move forward with it now instead of wait, since the overhaul has been stalled for so long. These changes should make the docs truly DSL2-first.