A community effort to collect a curated set of analysis pipelines built using Nextflow.

nf-core

<https://github.com/nf-core/configs/pull/900|#900 Improve adding config workflow documentation>
Pull request opened by <https://github.com/jfy133|jfy133>
---

## name: New Config  
about: A new cluster config

Please follow these steps before submitting your PR:

• If your PR is a work in progress, include `[WIP]` in its title
• Your PR targets the `master` branch
• You've included links to relevant issues, if any

Steps for adding a new config profile:

• Add your custom config file to the `conf/` directory
• Add your documentation file to the `docs/` directory
• Add your custom profile to the `nfcore_custom.config` file in the top-level directory
• Add your custom profile to the `README.md` file in the top-level directory
• Add your profile name to the `profile:` scope in `.github/workflows/main.yml`
• OPTIONAL: Add your custom profile path and GitHub user name to `.github/CODEOWNERS` (`**/&lt;custom-profile&gt;** @&lt;github-username&gt;`)
<https://github.com/nf-core/configs|nf-core/configs>

<@UGJEZTL4D> <@UE6D8290F> could you have a look?


Also should we remove the lists of configs on the README and just refer to the website page now?

:thumbsup_all:

I don't have any strong opinions on having the list of configs in there or not, so I guess removing it and getting rid of that edit stage for new configs might be a good thing.

I do care about searching "nf-core config SITEIDENTIFICATOR" giving sensible results, but the web site seem to be good enough.

If you feel overly ambitious you can add a bit upcoming nextflow changes with strict (so that maybe existing configs might not be great to look at), but if not, I can try to make that happen sometime.

Do we have more documentation somehwere what is accepted in configs?

I always wanted to point towards things about don't use complex groovy/conditiosn etc

<https://www.nextflow.io/docs/latest/strict-syntax.html#configuration-syntax>

<https://www.nextflow.io/docs/latest/config.html#config-syntax>

But really we need to overhaul that whole README, is very messy and inconsistent...

woudl you two be willing to have a 1-2h (to be generous) call to work out how to overhaul that whole documentation page?

<https://github.com/nf-core/configs/pull/900|#900 Improve adding config workflow documentation>
Pull request merged by <https://github.com/pontus|pontus>
<https://github.com/nf-core/configs|nf-core/configs>

Typically not mornings and not Monday or Friday. But due to other reasons I've also difficult to plan more than very short time with high confidence (meaning I can guarantee a specific time, but mostly it's not a problem).