docs: document orthogonal process resource labels (process_cpus_*/_mem_*/_time_*)#4212
Open
pinin4fjords wants to merge 4 commits into
Open
docs: document orthogonal process resource labels (process_cpus_*/_mem_*/_time_*)#4212pinin4fjords wants to merge 4 commits into
pinin4fjords wants to merge 4 commits into
Conversation
Introduce the axis-decomposed labels (process_cpus_*, process_mem_*, process_time_*) as the preferred scheme and mark the bundled labels (process_low, process_medium, process_high) as legacy. Add a migration guide for module authors, pipeline maintainers and site-config maintainers. Refs: nf-core/proposals#139 Refs: nf-core/tools#4265 [skip ci]
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
3 tasks
pinin4fjords
added a commit
to pinin4fjords/proposals
that referenced
this pull request
May 13, 2026
The /docs/contributing/migrating-resource-labels URL 404s until nf-core/website#4212 is merged, so point reviewers at the draft PR instead. [skip ci]
mashehu
reviewed
May 13, 2026
mashehu
reviewed
May 13, 2026
mashehu
reviewed
May 13, 2026
- Move migrating-resource-labels.md to developing/migration-guides/process-axis-labels.md. - Tighten prose: drop redundant phrasing, merge module-author and pipeline-maintainer steps into a single section, sharpen the "Why migrate" bullets. - Convert the two before/after migration examples to diff groovy blocks matching the strict-syntax migration guide's convention. - Reformat the axis label table in resource-requirements.md so each tier is its own cell, with empty cells aligning the "single" tier on the CPU axis with the absent tier on memory/time. - Update the two internal links (nextflow-for-your-system.md, resource-requirements.md) to the new migration-guide path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
prettier wants table cells padded to the longest content + 2 spaces; the previous version had a few stray trailing spaces. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
process_cpus_*,process_mem_*,process_time_*) the preferred pattern in the modules spec and mark the bundled labels (process_low,process_medium,process_high) as legacy.nextflow-for-your-system.mdto show the axis labels alongside an explainer of the legacy scheme.contribute-existing-pipelines.md.developing/migration-guides/process-axis-labels.md) with the legacy-to-axis mapping table, migration steps and a deprecation timeline.Companion to the template change in nf-core/tools#4265 and the approved RFC at nf-core/proposals#139.
Test plan
npm run build(or equivalent local docs build) renders the four touched pages without errors.resource-requirements.md,nextflow-for-your-system.mdandprocess-axis-labels.mdresolve.@netlify /docs/developing/migration-guides/process-axis-labels