Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
109 commits
Select commit Hold shift + click to select a range
3398a4f
Correct memory in test profile
pinin4fjords Oct 30, 2025
ef869bb
Reframe test profile section to avoid implying param inference
pinin4fjords Oct 30, 2025
73663f5
Update Nextflow version to 25.04.3 in nf-core materials
pinin4fjords Oct 30, 2025
2046e07
Update nf-core/demo version to 1.0.2
pinin4fjords Oct 30, 2025
a140ea4
Updated nf-core/demo output
pinin4fjords Oct 30, 2025
7ea59bd
mend
pinin4fjords Oct 30, 2025
f9cb647
update demo pipeline contents
pinin4fjords Oct 30, 2025
7519429
Refine subworkflow coverage
pinin4fjords Oct 30, 2025
879a0f2
correct tree level
pinin4fjords Oct 30, 2025
848ada1
Correct another tree level, params schema coverage
pinin4fjords Oct 30, 2025
4a43382
Update input schema content
pinin4fjords Oct 30, 2025
e64de7e
Fix priority issues in nf-core Part 1
pinin4fjords Oct 30, 2025
aba50d7
Improve style consistency in nf-core Part 1
pinin4fjords Oct 30, 2025
8b6378a
Add content enhancements to nf-core Part 1
pinin4fjords Oct 30, 2025
789c802
Fix issues in nf-core Part 2
pinin4fjords Oct 30, 2025
3b7dd22
fix workflow listing
pinin4fjords Oct 30, 2025
c0de862
Update first run output
pinin4fjords Oct 30, 2025
8d33f7c
Clarify section 3 transition in nf-core Part 2
pinin4fjords Oct 30, 2025
c8250d2
Add a highlight
pinin4fjords Oct 30, 2025
dbe6611
Reorder section 3.3 to show proper version channel pattern
pinin4fjords Oct 30, 2025
65e7de7
fix line num
pinin4fjords Oct 30, 2025
754f28e
Fix highlights, indents
pinin4fjords Oct 30, 2025
2d665af
More highlight fixes
pinin4fjords Oct 30, 2025
3bd54c5
Fix indents
pinin4fjords Oct 30, 2025
1d9dec3
Add missing highlights
pinin4fjords Oct 30, 2025
8597694
Clarify .view line removal in section 3.3
pinin4fjords Oct 30, 2025
6950066
Remove redundancy at section 4 start
pinin4fjords Oct 30, 2025
8f61263
Update solution
pinin4fjords Oct 30, 2025
2172ddd
Merge branch 'master' into minor_nfcore_fixes
pinin4fjords Oct 30, 2025
521618c
Fix linting errors in core-hello-part2 solution files
pinin4fjords Oct 30, 2025
6887f13
prettier
pinin4fjords Oct 30, 2025
3e4ff9e
Correct attribution of pipeline_info contents in section 4.5
pinin4fjords Oct 30, 2025
675ff55
Clarify nf-core module naming conventions
pinin4fjords Oct 30, 2025
5ca0877
Add info output
pinin4fjords Oct 30, 2025
b0bb38b
Update some outputs
pinin4fjords Oct 30, 2025
3738414
Fix cat content
pinin4fjords Oct 30, 2025
80d8d4e
update some outputs
pinin4fjords Oct 30, 2025
b93e362
Fix highlight
pinin4fjords Oct 30, 2025
abd223b
Update part 3 solution
pinin4fjords Oct 30, 2025
5ed5250
Remove legacy collectGreetings module from part 3
pinin4fjords Oct 30, 2025
a4ed3ff
Improve learning flow with contextual transitions
pinin4fjords Oct 30, 2025
b033936
Reframe Part 4 as 'Make an nf-core module'
pinin4fjords Oct 30, 2025
6896d72
Highlight additional nf-core conventions in template
pinin4fjords Oct 30, 2025
f05fa10
Clarify working within core-hello pipeline context
pinin4fjords Oct 30, 2025
782fdc6
Minor changes to nf-core part 4
pinin4fjords Oct 30, 2025
f4c06d5
Clarify ext.args usage and flexibility
pinin4fjords Oct 30, 2025
da5c6a4
Elevate and clarify centralized publishDir explanation
pinin4fjords Oct 30, 2025
ba7585a
tweak
pinin4fjords Oct 30, 2025
9567756
Add subtle Babylon 5 reference with kosh character
pinin4fjords Oct 30, 2025
f0a2dff
Enrich nf-core modules create section with environment/container details
pinin4fjords Oct 30, 2025
9abb837
Use --empty-template flag for cleaner module creation example
pinin4fjords Oct 30, 2025
4599597
Update module template to match actual --empty-template output
pinin4fjords Oct 30, 2025
fecc859
Add reference to nf-test side quest for testing
pinin4fjords Oct 30, 2025
0cd2ae1
Fix remaining file path links to use backticks
pinin4fjords Oct 30, 2025
1e30024
Clarify distinction between channel inputs and ext.args
pinin4fjords Oct 30, 2025
07eaae8
Fix highlight
pinin4fjords Oct 30, 2025
28d55a3
Fix highlight
pinin4fjords Oct 30, 2025
9903a25
Fix up part 4 solution
pinin4fjords Oct 30, 2025
c717558
Try some linting fixes
pinin4fjords Oct 30, 2025
5c02a4b
Fix linting errors in nf-core solution files
pinin4fjords Oct 30, 2025
66201a7
prettier
pinin4fjords Oct 30, 2025
7723bab
Fix nested list indentation in input validation docs
pinin4fjords Oct 30, 2025
4b64c3f
Fix list rendering in input validation docs
pinin4fjords Oct 30, 2025
add3cbf
Remove redundant sentence from validation section
pinin4fjords Oct 31, 2025
b0f1ffc
Clarify nf-schema as standalone plugin
pinin4fjords Oct 31, 2025
2f886f0
Update schema docs to use interactive builder tool
pinin4fjords Oct 31, 2025
0c481f8
Fix image links
pinin4fjords Oct 31, 2025
e243af6
Fix image paths in input validation docs
pinin4fjords Oct 31, 2025
3de3c4e
Fix validation configuration approach
pinin4fjords Oct 31, 2025
35d3206
Improve schema_input.json section with before/after
pinin4fjords Oct 31, 2025
ef9cfd3
Replace file link with backticked string
pinin4fjords Oct 31, 2025
2da8036
Reorganize validation configuration section
pinin4fjords Oct 31, 2025
cdebcd2
Polish validation docs for consistency and clarity
pinin4fjords Oct 31, 2025
06a246d
Add context about Hello Nextflow workflow
pinin4fjords Oct 31, 2025
0083c0e
Add course overview to orientation
pinin4fjords Oct 31, 2025
a194442
Add summary page to Hello nf-core course
pinin4fjords Oct 31, 2025
cae5504
Update Part 5 ending to point to summary page
pinin4fjords Oct 31, 2025
31b2ac4
Fix solutions
pinin4fjords Oct 31, 2025
8d37b37
Some linting fixes
pinin4fjords Oct 31, 2025
f3cdbea
Fix linting errors in core-hello-part5 solution
pinin4fjords Oct 31, 2025
16d2f3f
Fix remaining linting issues in core-hello-part5 solution
pinin4fjords Oct 31, 2025
43d222d
Strip nf-core side quest in favour of 'hello nf-core'
pinin4fjords Oct 31, 2025
a35789d
Fix workflow description to match actual behavior
pinin4fjords Oct 31, 2025
49b6945
Try some folding directory listings
pinin4fjords Oct 31, 2025
bcf14eb
Replace step labels and bold text with numbered headings in hello_nf-…
pinin4fjords Oct 31, 2025
dd73bdf
Prettier
pinin4fjords Oct 31, 2025
4f06fe9
Address Geraldine's editorial comments on Hello nf-core
pinin4fjords Nov 4, 2025
439f480
Remove remaining em-dashes from Hello nf-core
pinin4fjords Nov 4, 2025
21936bf
Address editorial comments from PR review
pinin4fjords Nov 4, 2025
c973b08
Move publishDir configuration details to note box
pinin4fjords Nov 4, 2025
659e075
Restore backticks
pinin4fjords Nov 4, 2025
e5301ca
Improve publishDir configuration explanation
pinin4fjords Nov 4, 2025
4b4517d
Minor editorial improvements to module creation section
pinin4fjords Nov 4, 2025
f8b57c9
Clarify module template customization requirements
pinin4fjords Nov 4, 2025
38e3550
Restructure validation intro and reduce overconfident claims
pinin4fjords Nov 4, 2025
35a281d
Clarify monochromeLogs parameter description
pinin4fjords Nov 4, 2025
31273b7
Clarify input data validation scope and monochromeLogs
pinin4fjords Nov 4, 2025
35b51fb
Make takeaway bullet more explicit about publishDir
pinin4fjords Nov 4, 2025
43f75d9
Prioritize visual output verification over command inspection
pinin4fjords Nov 4, 2025
1476787
Change section heading to avoid overloaded 'template' term
pinin4fjords Nov 4, 2025
bb96228
prettier
pinin4fjords Nov 4, 2025
464fc0c
Correct a highlight
pinin4fjords Nov 4, 2025
e0a79c0
Merge branch 'master' into minor_nfcore_fixes
adamrtalbot Nov 6, 2025
c0e1f41
Move "What you'll learn" content to index page
vdauwera Nov 6, 2025
0a4d306
Improvements to the Orientation page
vdauwera Nov 6, 2025
e92b430
minor tweaks
vdauwera Nov 6, 2025
740b5d0
Reworked Part 1 (run demo) for clarity and flow
vdauwera Nov 6, 2025
850fe48
Add green start button
vdauwera Nov 7, 2025
1fb065c
Completed updates to Part 2
vdauwera Nov 7, 2025
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
90 changes: 60 additions & 30 deletions docs/hello_nf-core/00_orientation.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
# Orientation
# Getting started

## GitHub Codespaces
To start the course, launch the training environment by clicking the "Open in GitHub Codespaces" button below.
We recommend opening the training environment in a new browser tab (use right-click, ctrl-click or cmd-click depending on your equipment) so that you can read on while the environment loads.
You will need to keep these instructions open in parallel.

The GitHub Codespaces environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
However, you do need a (free) GitHub account to log in, and you should take a few minutes to familiarize yourself with the interface.
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master)

If you have not yet done so, please go through the [Environment Setup](../../envsetup/) mini-course before going any further.
## Training environment

Our training environment runs on GitHub Codespaces (free Github account required) and contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.

The codespace is set up with a VSCode interface, which includes a filesystem explorer, a code editor and a terminal shell.
All instructions given during the course (e.g. 'open the file', 'edit the code' or 'run this command') refer to those three parts of the VScode interface unless otherwise specified.

If you are working through this course by yourself, please go through the [Environment Setup](../../envsetup/) mini-course for further details before going any further.

!!! warning

This training is designed for nf-core tools version 3.4.1, which should be the version installed in the codespace. If you use a different version of nf-core tooling you may have difficulty following along.
This training is designed for nf-core tools version 3.4.1, which should be the version installed in the codespace we provide.
If you use a different version of nf-core tooling, you may have difficulty following along.

You can check what version is installed using the command`nf-core --version`.

## Working directory
## Get ready to work

Once your codespace is running, there are two things you need to do before diving into the training: set your working directory for this specific course, and take a look at the materials provided.

Throughout this training course, we'll be working in the `hello-nf-core/` directory.
### Set the working directory

By default, the codespace opens with the work directory set at the root of all training courses, but for this course, we'll be working in the `hello-nf-core/` directory.

Change directory now by running this command in the terminal:

Expand All @@ -25,15 +38,15 @@ cd hello-nf-core/

!!! tip

If for whatever reason you move out of this directory, you can always use the full path to return to it, assuming you're running this within the Github Codespaces training environment:
If for whatever reason you move out of this directory (e.g. your codespace goes to sleep), you can always use the full path to return to it, assuming you're running this within the Github Codespaces training environment:

```bash
cd /workspaces/training/hello-nf-core
```

Now let's have a look at the contents of this directory.

## Materials provided
### Check out the materials provided

You can explore the contents of this directory by using the file explorer on the left-hand side of the training workspace.
Alternatively, you can use the `tree` command.
Expand All @@ -46,26 +59,33 @@ Here we generate a table of contents to the second level down:
tree . -L 2
```

If you run this inside `hello-nf-core`, you should see the following output:

```console title="Directory contents"
.
├── greetings.csv
├── original-hello
│ ├── hello.nf
│ ├── modules
│ └── nextflow.config
└── solutions
├── composable-hello
├── core-hello-part2
├── core-hello-part3
├── core-hello-part4
└── core-hello-start

8 directories, 3 files
```
If you run this inside `hello-nf-core`, you should see the following output.

??? example "Directory contents"

```console
.
├── greetings.csv
├── original-hello
│ ├── hello.nf
│ ├── modules
│ └── nextflow.config
└── solutions
├── composable-hello
├── core-hello-part2
├── core-hello-part3
├── core-hello-part4
└── core-hello-start

8 directories, 3 files
```

**Here's a summary of what you should know to get started:**
!!! note

We use collapsible sections like this to include expected command output in a concise way.
Click on the colored box to expand the section and view its contents.

**Content guide:**

- **The `greetings.csv` file** is a CSV containing some minimal columnar data we use for testing purposes.

Expand All @@ -74,4 +94,14 @@ If you run this inside `hello-nf-core`, you should see the following output:
- **The `solutions` directory** contains the completed workflow scripts that result from each step of the course.
They are intended to be used as a reference to check your work and troubleshoot any issues.

**Now, to begin the course, click on the arrow in the bottom right corner of this page.**
## Readiness checklist

Think you're ready to dive in?

- [ ] I understand the goal of this course and its prerequisites
- [ ] My codespace is up and running
- [ ] I've set my working directory appropriately

If you can check all the boxes, you're good to go.

**To continue to Part 1, click on the arrow in the bottom right corner of this page.**
Loading
Loading