Skip to content

Commit f21ffd7

Browse files
Merge pull request #515 from nextflow-io/maxulysse-patch-2
Update 00_orientation.md
2 parents 8f70e1f + bbbeffb commit f21ffd7

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

docs/hello_nextflow/00_orientation.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,35 @@
11
# Orientation
22

33
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.
4-
However, you do need a (free) account to log in, and you should take a few minutes to familiarize yourself with the interface.
4+
However, you do need a (free) GitHub account to log in, and you should take a few minutes to familiarize yourself with the interface.
55

6-
If you have not yet done so, please follow [this link](../../envsetup/) before going any further.
6+
If you have not yet done so, please go through the [Environment Setup](../../envsetup/) mini-course before going any further.
77

8-
## Materials provided
8+
## Working directory
9+
10+
Throughout this training course, we'll be working in the `hello-nextflow/` directory.
11+
12+
Change directory now by running this command in the terminal:
13+
14+
```bash
15+
cd hello-nextflow/
16+
```
917

10-
Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the training workspace.
11-
This directory contains all the code files, test data and accessory files you will need.
18+
!!!tip
19+
20+
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:
21+
22+
```bash
23+
cd /workspaces/training/hello-nextflow
24+
```
1225

13-
Feel free to explore the contents of this directory; the easiest way to do so is to use the file explorer on the left-hand side of the training workspace.
26+
Now let's have a look at the contents of this directory.
27+
28+
## Materials provided
29+
30+
You can explore the contents of this directory by using the file explorer on the left-hand side of the training workspace.
1431
Alternatively, you can use the `tree` command.
32+
1533
Throughout the course, we use the output of `tree` to represent directory structure and contents in a readable form, sometimes with minor modifications for clarity.
1634

1735
Here we generate a table of contents to the second level down:
@@ -60,12 +78,4 @@ If you run this inside `hello-nextflow`, you should see the following output:
6078
The name and number in the filename correspond to the step of the relevant part of the course.
6179
For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.
6280

63-
!!!tip
64-
65-
If for whatever reason you move out of this directory, you can always run this command to return to it (within the training environment):
66-
67-
```bash
68-
cd /workspaces/training/hello-nextflow
69-
```
70-
71-
Now, to begin the course, click on the arrow in the bottom right corner of this page.
81+
**Now, to begin the course, click on the arrow in the bottom right corner of this page.**

docs/hello_nextflow/01_hello_world.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ In this first part of the Hello Nextflow training course, we ease into the topic
1212

1313
Let's demonstrate this with a simple command that we run directly in the terminal, to show what it does before we wrap it in Nextflow.
1414

15+
!!! tip
16+
17+
Remember that you should now be inside the `hello-nextflow/` directory as described in the Orientation.
18+
1519
### 0.1. Make the terminal say hello
1620

1721
```bash

0 commit comments

Comments
 (0)