Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve install, usage, and configuration guide #2677

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9aea2d3
Updated install guide
christopher-hakkaart Aug 5, 2024
f90edbc
Update installation guide page
christopher-hakkaart Aug 5, 2024
7f3adaf
Update installation guide page
christopher-hakkaart Aug 5, 2024
a56cfcf
Update install directory
christopher-hakkaart Aug 5, 2024
cf6a7e8
First reshuffle usage guide
christopher-hakkaart Aug 9, 2024
f6794d8
Fix snake_case
christopher-hakkaart Aug 9, 2024
352db78
Remove note box that feels intrusive
christopher-hakkaart Aug 9, 2024
17a9f80
Remove note box that feels intrusive
christopher-hakkaart Aug 9, 2024
5b7416a
Remove note box that feels intrusive
christopher-hakkaart Aug 9, 2024
6f00844
Apply suggestions
christopher-hakkaart Aug 12, 2024
fe1f555
Merge branch 'main' into install-guide
christopher-hakkaart Aug 12, 2024
8eb3ac3
Prettier
christopher-hakkaart Aug 12, 2024
2e2d7bc
Prettier x2
christopher-hakkaart Aug 12, 2024
5891a9a
Fix header
christopher-hakkaart Aug 13, 2024
d80eec7
Small improvemnts
christopher-hakkaart Aug 13, 2024
5c85cc9
Fix code blocks
christopher-hakkaart Aug 13, 2024
b3aace6
Fix rendering issue
jfy133 Sep 3, 2024
6316c31
Update sites/docs/src/content/docs/usage/quick_start/introduction.md
christopher-hakkaart Sep 4, 2024
1d53601
Apply suggestions from code review
christopher-hakkaart Sep 4, 2024
5f6e5b8
Apply suggestions from code review
christopher-hakkaart Sep 5, 2024
6aeb60d
Small edits
christopher-hakkaart Sep 5, 2024
8a62037
Merge branch 'install-guide' of https://github.com/nf-core/website in…
christopher-hakkaart Sep 5, 2024
405a139
Apply suggested changes from comments
christopher-hakkaart Sep 5, 2024
6dca224
Prettier
christopher-hakkaart Sep 5, 2024
45e621f
Merge branch 'main' into install-guide
christopher-hakkaart Sep 5, 2024
967fe5d
Rename usage guides and typos
christopher-hakkaart Sep 9, 2024
210d30c
Fix index
christopher-hakkaart Sep 9, 2024
d1ce24c
Fix index again
christopher-hakkaart Sep 9, 2024
bcfe614
Blend in #2537
christopher-hakkaart Sep 11, 2024
1d374e3
Merge branch 'main' into install-guide
christopher-hakkaart Sep 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: nf-core Terminology
subtitle: Specification of the terms used in the nf-core community
shortTitle: nf-core terminology
title: Terminology
subtitle: nf-core terminology
---

The features offered by Nextflow DSL2 can be used in various ways depending on the granularity with which you would like to write pipelines. Please see the listing below for the hierarchy and associated terminology we have decided to use when referring to DSL2 components.
## Introduction

## Terminology
The features offered by Nextflow DSL2 can be used in various ways depending on the granularity with which you would like to write pipelines. Please see the listing below for the hierarchy and associated terminology nf-core uses when referring to DSL2 components.
christopher-hakkaart marked this conversation as resolved.
Show resolved Hide resolved

### Domain-Specific Language (DSL)

Expand All @@ -27,3 +26,5 @@ Component is our umbrella term for both modules and subworkflows, because they s
### Workflow

An end-to-end pipeline where one or more inputs produce a series of outputs. This can either be implemented using a large monolithic script or by using a combination of DSL2 modules and subworkflows. nf-core pipelines can have multiple workflows, such as processing different data types for the same ultimate purpose (such as in [nf-core/viralrecon](https://github.com/nf-core/viralrecon/tree/master/workflows))

- Specify `--hook_url YOUR-HOOK-URL` or set the `params.hook_url` in `nextflow.config` to receive notifications from your pipeline in Microsoft Teams or Slack. Learn how to set up an incoming webhook in [MS Teams](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=dotnet) and in [Slack](https://api.slack.com/messaging/webhooks).
christopher-hakkaart marked this conversation as resolved.
Show resolved Hide resolved
346 changes: 0 additions & 346 deletions sites/docs/src/content/docs/usage/Getting_started/configuration.md

This file was deleted.

177 changes: 0 additions & 177 deletions sites/docs/src/content/docs/usage/Getting_started/installation.md

This file was deleted.

98 changes: 0 additions & 98 deletions sites/docs/src/content/docs/usage/Getting_started/introduction.md

This file was deleted.

Loading
Loading