nf-core / nf-core/website

Improve documentation for using nf-core/tools for external pipelines/customizing it during development

Open
#2,693 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Is your feature request related to a problem? Please describe.
At the moment, there seems to be no concise guide on how to use nf-core/tools for custom pipelines and how to deal with the various components.

This page is touching on what to update in the documentation and removing the .github files. But it is placed under guidelines. While developing a pipeline I find it more natural to check somewhere where also the remaining developmental steps are explained.

There is also this guide under he tools documentation for removing components while creating the pipeline https://nf-co.re/docs/nf-core-tools/pipelines/create#customization . Also not the first place I would check during development, since my pipeline was already created.

Describe the solution you'd like
A collection of resources could be a good start on what to do when you develop a pipeline outside of nf-core.

Describe alternatives you've considered
A new guide may duplicate information and get out of sync. The documentation around customizing the create command should really stay with tools

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the external use page and the nf-core/tools pipeline customization guide linked in the issue. Identify which development steps are missing or duplicated, then consolidate the relevant guidance into a clear location for external pipeline development while keeping create-command customization with the tools documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.