Skip to content

docs: Add config tutorial#4231

Open
christopher-hakkaart wants to merge 18 commits into
mainfrom
chris-config-user-guide
Open

docs: Add config tutorial#4231
christopher-hakkaart wants to merge 18 commits into
mainfrom
chris-config-user-guide

Conversation

@christopher-hakkaart

@christopher-hakkaart christopher-hakkaart commented May 25, 2026

Copy link
Copy Markdown
Member

@netlify /docs/running/tutorials/configure-a-pipeline-run

@netlify

netlify Bot commented May 25, 2026

Copy link
Copy Markdown

Deploy Preview for nf-core-main-site ready!

Name Link
🔨 Latest commit 964f3d5
🔍 Latest deploy log https://app.netlify.com/projects/nf-core-main-site/deploys/6a3459e5d043110008f42d8b
😎 Deploy Preview https://deploy-preview-4231--nf-core-main-site.netlify.app/docs/running/tutorials/configure-a-pipeline-run
📱 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 project configuration.

@christopher-hakkaart

Copy link
Copy Markdown
Member Author

@nf-core-bot fix linting

@christopher-hakkaart christopher-hakkaart marked this pull request as ready for review May 25, 2026 01:02
@christopher-hakkaart

Copy link
Copy Markdown
Member Author

@jfy133 - This is a first attempt at a new tutorial. I side on keeping things short and punchy, without too many verbose descriptions. I may have taken this too far. Let me know what you think.

@christopher-hakkaart

Copy link
Copy Markdown
Member Author

Note that I added an ENV variable section as I think this is increasingly important, given syntax changes and setting versions.

@github-actions github-actions Bot deleted a comment from netlify Bot Jun 3, 2026
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Halfway through

Comment thread sites/docs/src/content/docs/get_started/run-your-first-pipeline.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Halfway through

Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Finished!

Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
@christopher-hakkaart

Copy link
Copy Markdown
Member Author

Sorry - super messy merge after my VS Code did something weird and moved all the comments.

@jfy133

jfy133 commented Jun 16, 2026

Copy link
Copy Markdown
Member

@nf-core-bot fix linting

@jfy133

jfy133 commented Jun 16, 2026

Copy link
Copy Markdown
Member

Note @christopher-hakkaart the deploy preview still ain't working for that page, I don't know why. Will review the markdown in the meantime

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

More minor comments, I will make a PR against nf-core/demo in the meantime to help with validating the output of

Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
}
```

Re-run the baseline command. No `-c` flag is needed, Nextflow picks the file up automatically:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A bit annoying we don't have something to confirm this still...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I still find this weird. Need to double-check.

Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated
Comment thread sites/docs/src/content/docs/running/tutorials/configure-a-pipeline-run.md Outdated

```bash
export NXF_VER=25.10.4
export NXF_WORK=$HOME/nf-demo-work

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I personally wouldn't want to pollute someones home directory with a tutorial it should remain selfcontained... should we start saying 'make a directory called nf-core-configuration-tutorial and have evertyhign running from within there? Then they can easily delete at the end.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Maybe we should set the ENV variable in the first step 😉

But yes, we can say make a folder and do everything there.

@jfy133

jfy133 commented Jun 16, 2026

Copy link
Copy Markdown
Member

This PR adding a local module seems to help, I see changes in the execution report (if it doesn't exceed the resourceLimits in the test.config: nf-core/demo#57

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants