Skip to content

Commit 64bd2b1

Browse files
committed
Cleaned up some missed mentions. Removed some old screenshot images
1 parent 4d5b454 commit 64bd2b1

File tree

13 files changed

+14
-42
lines changed

13 files changed

+14
-42
lines changed

docs/basic_training/containers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ docker images
126126

127127
??? Solution
128128

129-
Use your favorite editor (e.g., `vim` or `nano`) to create a file named `Dockerfile`. Alternatively, run `code Dockerfile` to create a a file named `Dockerfile` in Gitpod. Copy the following content:
129+
Use your favorite editor (e.g., `vim` or `nano`) to create a file named `Dockerfile`. Alternatively, run `code Dockerfile` to create a a file named `Dockerfile`. Copy the following content:
130130

131131
```dockerfile linenums="1" title="Dockerfile"
132132
FROM debian:bullseye-slim
@@ -624,7 +624,7 @@ mulled-search --destination quay singularity --channel bioconda --search bowtie
624624

625625
!!! question "Exercise"
626626

627-
During the earlier RNA-Seq tutorial (script2.nf), you created an index with the salmon tool. Given you do not have salmon installed locally in the machine provided by Gitpod, you had to either run it with `-with-conda` or `-with-docker`. Your task now is to run it again `-with-docker`, but without creating your own container image. Instead, use the BioContainers image for salmon 1.7.0.
627+
During the earlier RNA-Seq tutorial (script2.nf), you created an index with the salmon tool. Given you do not have salmon installed locally in the machine provided by GitHub Codespaces, you had to either run it with `-with-conda` or `-with-docker`. Your task now is to run it again `-with-docker`, but without creating your own container image. Instead, use the BioContainers image for salmon 1.7.0.
628628

629629

630630
??? Solution
-389 KB
Binary file not shown.

docs/hello_nextflow/01_orientation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Orientation
22

3-
The Gitpod environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
3+
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.
44
However, you do need a (free) account to log in, and you should take a few minutes to familiarize yourself with the interface.
55

66
If you have not yet done so, please follow [this link](../../envsetup/) before going any further.
77

88
## Materials provided
99

10-
Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the Gitpod workspace.
10+
Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the GitHub Codespaces workspace.
1111
This directory contains all the code files, test data and accessory files you will need.
1212

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 Gitpod workspace.
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 GitHub Codespaces workspace.
1414
Alternatively, you can use the `tree` command.
1515
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.
1616

docs/hello_nextflow/02_hello_world.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ cat output.txt
3636

3737
!!! tip
3838

39-
In the Gitpod environment, you can also find the output file in the file explorer, and view its contents by clicking on it. Alternatively, you can use the `code` command to open the file for viewing.
39+
In the GitHub Codespaces environment, you can also find the output file in the file explorer, and view its contents by clicking on it. Alternatively, you can use the `code` command to open the file for viewing.
4040

4141
```bash
4242
code output.txt
@@ -181,7 +181,7 @@ Have a look inside; you'll find a subdirectory named with a hash (in order to ma
181181

182182
!!! tip
183183

184-
If you browse the contents of the task subdirectory in the Gitpod's VSCode file explorer, you'll see all these files right away.
184+
If you browse the contents of the task subdirectory in the VSCode file explorer, you'll see all these files right away.
185185
However, these files are set to be invisible in the terminal, so if you want to use `ls` or `tree` to view them, you'll need to set the relevant option for displaying invisible files.
186186

187187
```bash

docs/hello_nextflow/04_hello_genomics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ gatk HaplotypeCaller \
131131
-L /data/ref/intervals.bed
132132
```
133133

134-
The output file `reads_mother.vcf` is created inside your working directory in the container, so you won't see it in the Gitpod file explorer unless you change the output file path.
134+
The output file `reads_mother.vcf` is created inside your working directory in the container, so you won't see it in the VS Code file explorer unless you change the output file path.
135135
However, it's a small test file, so you can `cat` it to open it and view the contents.
136136
If you scroll all the way up to the start of the file, you'll find a header composed of many lines of metadata, followed by a list of variant calls, one per line.
137137

@@ -732,7 +732,7 @@ As you can see, we listed one file path per line, and they are absolute paths.
732732

733733
!!! note
734734

735-
The files we are using here are just on your Gitpod's local filesystem, but we could also point to files in cloud storage.
735+
The files we are using here are just on your GitHub Codespaces's local filesystem, but we could also point to files in cloud storage.
736736

737737
### 4.2. Update the parameter default
738738

docs/hello_nextflow/06_hello_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ Basically we are telling Nextflow to generate a Slurm submission script and subm
468468

469469
### 3.2. Launch the workflow to generate the job submission script
470470

471-
Let's try running this; even though we know it won't execute (since we don't have Slurm set up in this Gitpod environment) we'll be able to see what the submission script looks like.
471+
Let's try running this; even though we know it won't execute (since we don't have Slurm set up in this GitHub Codespaces environment) we'll be able to see what the submission script looks like.
472472

473473
```bash
474474
nextflow run main.nf -profile conda_on
@@ -720,7 +720,7 @@ To have Nextflow generate the report automatically, simply add `-with-report <fi
720720
nextflow run main.nf -profile my_laptop -with-report report-config-1.html
721721
```
722722

723-
The report is an html file, which you can download and open in your browser. You can also right click it in the file explorer on the left and click on `Show preview` in order to view it on Gitpod.
723+
The report is an html file, which you can download and open in your browser. You can also right click it in the file explorer on the left and click on `Show preview` in order to view it in GitHub Codespaces.
724724

725725
Take a few minutes to look through the report and see if you can identify some opportunities for adjusting resources.
726726
Make sure to click on the tabs that show the utilization results as a percentage of what was allocated.
@@ -829,7 +829,7 @@ _After:_
829829
}
830830
```
831831

832-
We can't test this since we don't have a live connection to Slurm in the Gitpod environment.
832+
We can't test this since we don't have a live connection to Slurm in the GitHub Codespaces environment.
833833
However, you can try running the workflow with resource allocations that exceed these limits, then look up the `sbatch` command in the `.command.run` script file.
834834
You should see that the requests that actually get sent to the executor are capped at the values specified by `resourceLimits`.
835835

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ When you're ready to get down to work, click on the 'Open in GitHub Codespaces'
4343

4444
:material-lightbulb: Essential for setting up your environment for the first time.
4545

46-
Instructions for setting up your environment to work through training materials (all courses). Provides an orientation to Gitpod as well as alternate installation instructions for working on your own local machine.
46+
Instructions for setting up your environment to work through training materials (all courses). Provides an orientation to GitHub Codespaces as well as alternate installation instructions for working on your own local machine.
4747

4848
[Launch the Environment Setup training :material-arrow-right:](envsetup/index.md){ .md-button .md-button--primary }
4949

@@ -121,7 +121,7 @@ When you're ready to get down to work, click on the 'Open in GitHub Codespaces'
121121

122122
:material-run-fast: A short hands-on tutorial focused on a concrete analysis pipeline example.
123123

124-
This course was developed as a "learn by doing" tutorial intended as a fast, hands-on way to get to grips with Nextflow using a very concrete analysis pipeline example. You can still find the materials in the GitHub repository, but it is no longer being maintained and can no longer be launched in Gitpod or in the training portal.
124+
This course was developed as a "learn by doing" tutorial intended as a fast, hands-on way to get to grips with Nextflow using a very concrete analysis pipeline example. You can still find the materials in the GitHub repository, but it is no longer being maintained and can no longer be launched in GitHub Codespaces or in the training portal.
125125

126126
## Resources
127127

docs/nf_develop/1_01_orientation.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,6 @@ This is an empty directory where you will create an launch your pipeline.
2020
cd /workspace/gitpod/nf-develop
2121
```
2222

23-
<!---
24-
25-
## Configuring GitHub
26-
27-
As a part of this workshop you will push changes to your GitHub.
28-
29-
If this is the first time you have used Gitpod for development work you will need to edit your permissions to push changes.
30-
31-
To edit your Gitpod permissions, open your Gitpod dashboard by clicking on the three horizontal lines in the top left-hand corner of your browser window and select `Gitpod: Open Dashboard` from the dropdown menu.
32-
33-
![Open Gitpod dashboard](img/gitpod.opendashboard.png)
34-
35-
In your dashboard, click on your avatar in the top right-hand corner of your window and select `User Settings` from the dropdown menu.
36-
37-
![Gitpod dashboard](img/gitpod.dashboard.png)
38-
39-
Click on `Git Providers` on the right hand menu.
40-
41-
![Git providers](img/gitpod.providers.png)
42-
43-
Edit the permissions for your GitHub account by clicking on the three dots next to your GitHub account and give your Gitpod account permissions to access for GitHub repositories.
44-
45-
![GitHub permissions](img/gitpod.permissions.png)
46-
47-
Once complete, click `Update permissions` and return to your Gitpod training environment.
48-
49-
-->
50-
5123
---
5224

5325
Congratulations! You are now ready to start the workshop!
-183 KB
Binary file not shown.
-335 KB
Binary file not shown.

0 commit comments

Comments
 (0)