Skip to content

[docs-v2] suggestions for 'running' sections#3727

Merged
jfy133 merged 12 commits intonf-core:docs-v2from
jfy133:docs-v2-jfy133-running-suggestions
Mar 3, 2026
Merged

[docs-v2] suggestions for 'running' sections#3727
jfy133 merged 12 commits intonf-core:docs-v2from
jfy133:docs-v2-jfy133-running-suggestions

Conversation

@jfy133
Copy link
Copy Markdown
Member

@jfy133 jfy133 commented Jan 23, 2026

Got to mid-way through 'nextflow for your system'.

Also need to add TODOs on these thoughts:

  • Running > Reference Genomes: I've moved the 'local genome' section first, as I think that is the most inclsuive and common method (iGenomnes only works specifically for essnetial model organisms) (TODO not necessarily)
  • Running > Reference GEnomes > RefGenie: The RefGenie instructions I'm suspicious of, it refers to the tool maknig a Nextflow config but I see no reference to this on the refgeni website (but note that the instructions are the same on the current docs site), [we need to find who wrote those... bgit glame isn't helping] (TODO ✅)
  • Running > Running pipelines offline: I don't understand what it means by 'copy the plugins' from where do oyu see the list of plugins? [again need the author to clarify] (TODO - no longer present, maybe now removed)
  • Running > Running pipelines offline > Transfer reference genomes offline: link to Reference genomes is dead (TODO ✅)
  • running/configuration/overview > I feel the 'Nextflow loads configuration parameters sequentially and overwrites previous values. The loading order is:' should go first, because this applies to everything (e.g. you can give a -c even if you've also given a -profile) (TODO ✅)
  • running/configuration/overview: Is Parameters in custom.config files will not override defaults in nextflow.config. Use -params-file with YAML or JSON format instead. correct? I'm pretty sure nextflow.coinfig is even more base that base.conf (TODO ✅)

@netlify /docs/contributing/documentation

@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 23, 2026

Deploy Preview for nf-core-docs ready!

Name Link
🔨 Latest commit 9c43ec3
🔍 Latest deploy log https://app.netlify.com/projects/nf-core-docs/deploys/69a66a014312e5000738622d
😎 Deploy Preview https://deploy-preview-3727--nf-core-docs.netlify.app/docs/contributing/documentation
📱 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.

@jfy133 jfy133 marked this pull request as draft January 23, 2026 21:03
@jfy133
Copy link
Copy Markdown
Member Author

jfy133 commented Mar 2, 2026

@nf-core-bot fix linting

@jfy133
Copy link
Copy Markdown
Member Author

jfy133 commented Mar 2, 2026

To finish review:

  • run-pipelines.md
  • advanced-topics/google-colb.md
  • advanced/topics/managing_work_directory_growth.md

@jfy133 jfy133 marked this pull request as ready for review March 3, 2026 04:56
@jfy133 jfy133 merged commit 4140a5c into nf-core:docs-v2 Mar 3, 2026
8 of 9 checks passed
@jfy133 jfy133 deleted the docs-v2-jfy133-running-suggestions branch March 3, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants