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

Incorporate DSL2 features into docs #3793

Merged
merged 13 commits into from
Oct 15, 2023
Merged

Conversation

bentsherman
Copy link
Member

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.

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Copy link
Member

@ewels ewels left a 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! 🚀

docs/dsl1.rst Outdated Show resolved Hide resolved
docs/dsl1.rst Outdated Show resolved Hide resolved
docs/dsl1.rst Outdated Show resolved Hide resolved
docs/dsl1.rst Outdated Show resolved Hide resolved
docs/dsl1.rst Outdated Show resolved Hide resolved
docs/script.rst Outdated Show resolved Hide resolved
docs/script.rst Outdated Show resolved Hide resolved
docs/workflow.rst Outdated Show resolved Hide resolved
docs/workflow.rst Outdated Show resolved Hide resolved
docs/workflow.rst Outdated Show resolved Hide resolved
bentsherman and others added 2 commits March 24, 2023 09:37
Co-authored-by: Phil Ewels <phil@seqera.io>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman
Copy link
Member Author

@pditommaso ready to merge?

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@netlify
Copy link

netlify bot commented Sep 18, 2023

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 148a34b
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/652bfafc3fe7bd0008c4cf9a
😎 Deploy Preview https://deploy-preview-3793--nextflow-docs-staging.netlify.app/workflow
📱 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.

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman
Copy link
Member Author

@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 <bentshermann@gmail.com>
@bentsherman
Copy link
Member Author

@pditommaso can we please merge this before the stable release?

@pditommaso
Copy link
Member

I'll check asap

@ewels ewels added this to the 23.10.0 milestone Oct 13, 2023
@pditommaso
Copy link
Member

I cannot build this. Does it require some changes in the sphinx container?

» b make-html.sh
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v5.3.0

Extension error:
Could not import extension sphinxext.rediraffe (exception: No module named 'sphinxext')
make: *** [Makefile:45: html] Error 2
Done. See _build/html/index.html

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@pditommaso
Copy link
Member

pditommaso commented Oct 15, 2023

Solved! 148a34b 😎

@pditommaso
Copy link
Member

Nice job! 👍

@pditommaso pditommaso merged commit efd041c into master Oct 15, 2023
11 checks passed
@pditommaso pditommaso deleted the ben-dsl1-migration-guide branch October 15, 2023 14:46
@ewels
Copy link
Member

ewels commented Oct 16, 2023

abhi18av pushed a commit to abhi18av/nextflow that referenced this pull request Oct 28, 2023

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Co-authored-by: Phil Ewels <phil@seqera.io>
Co-authored-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
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.

3 participants