Skip to content

Commit 2e1b6c0

Browse files
authored
Update gitpod defaults + training portal home page and related (#404)
**Update gitpod defaults** - Switch default work directory to Hello Nextflow - Also open the Hello Nextflow training page in the simple browser - Reorder how the trainings are listed in the file explorer - Hide the RNAseq hands-on training directory in the gitpod (deprecating it) **Reorganize and polish the training homepage and related pages** - Remove launch button for the RNAseq hands-on training - Make course index page titles more explicit
1 parent b963b5f commit 2e1b6c0

File tree

13 files changed

+71
-90
lines changed

13 files changed

+71
-90
lines changed

.gitpod.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ tasks:
2323
- before: printf 'unset JAVA_TOOL_OPTIONS\n' >> $HOME/.bashrc && exit
2424

2525
- name: Start web server
26-
command: gp ports await 23000 && gp preview https://training.nextflow.io
26+
command: gp ports await 23000 && gp preview https://training.nextflow.io/hello_nextflow
2727

2828
- name: Load Nextflow Tutorial
2929
command: docker pull -q nextflow/rnaseq-nf
3030

3131
- name: Start Nextflow Tutorial
3232
command: |
33-
cd nf-training
33+
cd hello-nextflow
3434
source $HOME/.bashrc
3535
export PS1='\[\e[3;36m\]${PWD/*\//} ->\[\e[0m\] '
3636
unset JAVA_TOOL_OPTIONS

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ We are excited to have you on the path to writing reproducible and scalable scie
99

1010
- 👉🏻 Written training material: <https://training.nextflow.io>
1111

12-
- 👩🏻‍💻 Instructions on loading this repository within a GitPod environment: <https://training.nextflow.io/basic_training/setup/>
12+
- 👩🏻‍💻 Instructions on loading this repository within a GitPod environment: <https://training.nextflow.io/envsetup/>
1313

1414
- 📚 Nextflow documentation: <https://www.nextflow.io/docs/latest/>
1515

1616
## Contributions
1717

18-
We welcome fixes and improvements from the community. Please fork the repository and create pull-requests with any improvements to the docs.
18+
We welcome fixes and improvements from the community. Please fork the repository and create pull-requests with any improvements you'd like to suggest to the docs.
1919

2020
You can find instructions about how to develop the training material code in [`CONTRIBUTING.md`](CONTRIBUTING.md). If you want to contribute with a translation instead, check [`TRANSLATING.md`](TRANSLATING.md).
2121

2222
## Credits & Copyright
2323

24-
All training material was originally written by [Seqera](https://seqera.io) but has been made open-source ([CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/)) for the community.
24+
This training material is developed and maintained by [Seqera](https://seqera.io) and released under an open-source license ([CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/)) for the benefit of the community. You are welcome to reuse these materials according to the terms of the license. If you are an instructor running your own trainings, we'd love to hear about how it goes and what we could do to make it easier.
2525

2626
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" src="docs/assets/img/cc_by-nc-nd.svg" /></a>
2727

28-
> Copyright 2020-2023, Seqera. All examples and descriptions are licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
28+
> Copyright 2024, Seqera. All examples and descriptions are licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.

docs/advanced/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# Advanced Training
22

33
Welcome to our Nextflow workshop for intermediate and advanced users!
44

docs/basic_training/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# Fundamentals Training
22

33
You are now on the path to writing reproducible and scalable scientific workflows using Nextflow. This guide complements the full [Nextflow documentation](https://www.nextflow.io/docs/latest) - if you ever have any doubts, please refer to that.
44

docs/envsetup/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Introduction
1+
# Environment Setup
22

3-
Training on the Nextflow community training portal are optimized for use within our Gitpod environment.
3+
The training courses offered on the Nextflow community training portal are optimized for use within our Gitpod environment.
44

55
Gitpod offers a virtual machine with everything already set up for you, accessible from your web browser or built into your code editor (e.g., VSCode).
66

docs/hello_nextflow/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Introduction
2+
title: Hello Nextflow
33
hide:
44
- toc
55
---

docs/help.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,18 @@
22

33
## Nextflow Documentation
44

5-
Even the most proficient developers need documentation.
6-
Nextflow is no different, and has an excellent set of docs.
7-
You can find the Nextflow docs at <https://nextflow.io/docs/latest/> - we recommend keeping them open in a tab whilst you follow the training!
5+
Nextflow has an excellent set of [docs](https://nextflow.io/docs/latest/), which should be your first destination whenever you run into something you don't understand or want to learn more about. You can browse topics or search for specific terms.
86

97
## community.seqera.io
108

11-
The [Seqera community forum](https://community.seqera.io) is a great place to ask questions about Nextflow. It's also a great place to find answers to questions that have already been asked!
12-
13-
Questions about Nextflow can be asked under the [Nextflow category](https://community.seqera.io/c/nextflow/5) with any relevant tags.
14-
15-
## Slack
9+
If you're struggling with the training, please don't hesitate to reach out for help. Our amazing community is one of the great strengths of Nextflow!
1610

17-
If you're struggling with the training please don't hesitate to reach out for help.
18-
Our amazing community is one of the great strengths of Nextflow!
19-
20-
There are two relevant Slack instances:
21-
22-
- Nextflow ([register here](https://www.nextflow.io/slack-invite.html))
23-
- nf-core ([register here](https://nf-co.re/join/slack))
11+
The [Seqera community forum](https://community.seqera.io) is a great place to ask questions about Nextflow. It's also a great place to find answers to questions that have already been asked!
2412

25-
Generally, the Nextflow slack is best as it caters for the entire community.
26-
The exception is if you're following the training with a workshop organised by nf-core, in which case you should have been told about where to ask questions.
13+
If you can't find a solution to your problem, just log in and click the "New Topic" button to post your question in the [Ask for Help](https://community.seqera.io/c/help/37) category. Feel free to include any tags you think might be relevant, since those can help our team and your peers find and answer your question.
2714

28-
## Ask the professionals
15+
## Professional support
2916

30-
Nextflow is a free and open-source software, developed by [Seqera](https://seqera.io/).
31-
Seqera offers a professional support service for Nextflow and associated products, as well as running bespoke training sessions.
17+
Nextflow is a free and open-source software developed by [Seqera](https://seqera.io/), a company headquartered in Spain with satellite offices in the UK and the US.
3218

33-
If this sounds like something that might be of interest, please [Get in touch](https://seqera.io/demo/).
19+
Seqera offers professional support services for Nextflow and associated products, including bespoke training sessions. If this sounds like something that might be of interest to you, please [Get in touch](https://seqera.io/demo/).

docs/index.md

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ hide:
1111

1212
Welcome to the Nextflow community training portal!
1313

14-
These training materials are open source and free to use for anyone.
15-
They are hosted in a [GitHub repository](https://github.com/nextflow-io/training) along with example scripts and development configuration.
14+
We have several distinct training courses available on this website. Scroll down to find the one that's right for you!
1615

17-
Whilst you can follow the materials any time, you'll probably get the most out of them by joining an organized training event.
18-
Free online events are organized regularly with the nf-core community, see the [nf-core events page](https://nf-co.re/events) for more.
16+
The training courses listed below are designed to be useable as a self-service resource; you can work through them on your own at any time (see Training Environment Setup for practical details). However, you may get even more out of them by joining a group training event.
1917

20-
We have several workshops available on this website - find the one that's right for you!
18+
- Free online events are run regularly by the nf-core community, see the [nf-core events page](https://nf-co.re/events) for more.
19+
- Seqera (the company that develops Nextflow) runs a variety of training events, see the [Seqera Events](https://seqera.io/events/) page and look for 'Seqera Sessions' and 'Nextflow Summit'.
20+
- Our Community team also regularly teaches trainings hosted by third party organizations; announcements and signups for those are typically managed by the third-party hosts.
21+
22+
When you're ready to get down to work, click on the 'Open in Gitpod' button, either on this page or on the index page of the course you chose, to open a web-based training environment (requires a free Github account).
2123

2224
[![Open in Gitpod](https://img.shields.io/badge/Gitpod-%20Open%20in%20Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/nextflow-io/training)
2325

@@ -27,45 +29,47 @@ We have several workshops available on this website - find the one that's right
2729

2830
!!! quote inline end ""
2931

30-
:material-lightbulb: Essential for setting up your Gitpod for the first time.
32+
:material-lightbulb: Essential for setting up your environment for the first time.
3133

32-
An essential tutorial for setting up your Gitpod environment for the first time.
34+
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.
3335

3436
[Launch the environment setup training :material-arrow-right:](envsetup/index.md){ .md-button .md-button--primary }
3537

36-
## Nextflow Training
38+
## Nextflow for Newcomers
3739

38-
!!! exercise "Fundamentals Training"
40+
!!! exercise "Hello Nextflow"
3941

40-
!!! tip inline end ""
42+
!!! quote inline end ""
4143

42-
:material-lightbulb: This is the primary Nextflow training material used in most Nextflow and nf-core training events.
44+
:material-run-fast: A modular training series for getting started with Nextflow.
4345

44-
The fundamentals training material includes all things Nextflow. Perfect for anyone looking to get to grips with using Nextflow to run analyses and build workflows.
46+
This is a foundational course for those who are completely new to Nextflow. It consists of a series of training modules that are designed to help learners build up their skills progressively. The series covers the core components of the Nextflow language as well as essential pipeline design and development practices, and effective use of third-party resources.
4547

46-
[Launch the fundamentals training :material-arrow-right:](basic_training/index.md){ .md-button .md-button--primary }
48+
[Launch the Hello Nextflow training :material-arrow-right:](hello_nextflow/index.md){ .md-button }
4749

48-
!!! exercise "Advanced Training"
50+
## In-depth Nextflow Training
4951

50-
!!! quote inline end ""
52+
!!! exercise "Fundamentals Training"
5153

52-
:material-lightbulb: This is the Nextflow training material used in advanced training events.
54+
!!! tip inline end ""
5355

54-
Advanced material exploring the advanced features of the Nextflow language and runtime, and how to use them to write efficient and scalable data-intensive workflows.
56+
:material-lightbulb: Comprehensive training material for exploring the full scope of Nextflow's capabilities.
5557

56-
[Launch the advanced training :material-arrow-right:](advanced/index.md){ .md-button .md-button--primary }
58+
The fundamentals training material covers all things Nextflow. Excellent reference material for anyone looking to build complex workflows with Nextflow.
5759

58-
## Applied Training
60+
[Launch the fundamentals training :material-arrow-right:](basic_training/index.md){ .md-button .md-button--primary }
5961

60-
!!! exercise "Hello Nextflow"
62+
!!! exercise "Advanced Training"
6163

6264
!!! quote inline end ""
6365

64-
:material-run-fast: This course is a short workshop to introduce you to Nextflow.
66+
:material-lightbulb: Advanced training material for mastering Nextflow.
6567

66-
A "learn by doing" tutorial that will take you from running tools on the command line into running your first Nextflow pipelines.
68+
Advanced material exploring the more advanced features of the Nextflow language and runtime, and how to use them to write efficient and scalable data-intensive workflows.
6769

68-
[Launch the Hello Nextflow training :material-arrow-right:](hello_nextflow/index.md){ .md-button }
70+
[Launch the advanced training :material-arrow-right:](advanced/index.md){ .md-button .md-button--primary }
71+
72+
## Other/Experimental
6973

7074
!!! exercise "Configure the execution of an nf-core pipeline"
7175

@@ -87,25 +91,25 @@ We have several workshops available on this website - find the one that's right
8791

8892
[Launch the nf-core template training :material-arrow-right:](nf_develop/index.md){ .md-button }
8993

90-
!!! exercise "Simple RNA-seq variant calling"
94+
!!! exercise "Troubleshooting exercises"
9195

9296
!!! quote inline end ""
9397

94-
:material-run-fast: This course is quite short and hands-on, great if you want to practice your Nextflow skills.
98+
:material-run-fast: This course will help you troubleshooting common pipeline errors.
9599

96-
A "learn by doing" tutorial focusing on theory, instead of leading through exercises of slowly increasing complexity.
100+
A "learn by doing" troubleshooting tutorial for pipeline developers and users.
97101

98-
[Launch the simple RNA-seq variant calling training :material-arrow-right:](hands_on/index.md){ .md-button }
102+
[Launch the troubleshooting training :material-arrow-right:](troubleshoot/index.md){ .md-button }
99103

100-
!!! exercise "Troubleshooting exercises"
104+
## Deprecated
101105

102-
!!! quote inline end ""
106+
!!! exercise "Simple RNA-seq variant calling"
103107

104-
:material-run-fast: This course will help you troubleshooting common pipeline errors.
108+
!!! quote inline end ""
105109

106-
A "learn by doing" troubleshooting tutorial for pipeline developers and users.
110+
:material-run-fast: A short hands-on tutorial focused on a concrete analysis pipeline example.
107111

108-
[Launch the troubleshooting training :material-arrow-right:](troubleshoot/index.md){ .md-button }
112+
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.
109113

110114
## Resources
111115

@@ -115,18 +119,17 @@ Quick reference to some handy links:
115119
| ----------------------------------------------------------- | ------------------------------------------------------------ |
116120
| [Nextflow Docs](https://nextflow.io/docs/latest/index.html) | [Nextflow Slack](https://www.nextflow.io/slack-invite.html)  |
117121
| [Nextflow Homepage](https://nextflow.io/) | [nf-core](https://nf-co.re/) |
118-
| [Seqera](https://seqera.io/) | [Seqera Community](https://community.seqera.io) |
122+
| [Seqera](https://seqera.io/) | [Seqera Community Forum](https://community.seqera.io) |
119123

120124
Not sure where to go? Check out the [Getting help](help.md) page.
121125

122126
## Credits and contributions
123127

124128
[![Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0](assets/img/cc_by-nc-nd.svg){ align=right }](https://creativecommons.org/licenses/by-nc-nd/4.0/)
125129

126-
All training material was originally written by [Seqera](https://seqera.io) but has been made open-source ([CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/)) for the community.
130+
This training material is developed and maintained by [Seqera](https://seqera.io) and released under an open-source license ([CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/)) for the benefit of the community. You are welcome to reuse these materials according to the terms of the license. If you are an instructor running your own trainings, we'd love to hear about how it goes and what we could do to make it easier.
127131

128-
We welcome fixes and improvements from the community.
129-
Every page has a :material-file-edit-outline: icon in the top right of the page, which will take you to GitHub where you can edit the training source material via a pull request.
132+
We welcome fixes and improvements from the community. Every page has a :material-file-edit-outline: icon in the top right of the page, which will take you to GitHub where you can propose changes to the training source material via a pull request.
130133

131134
<div markdown class="homepage_logos">
132135

docs/nf_customize/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# Configure nf-core
22

33
nf-core is a community effort to collaborate on a curated set of analysis pipelines built using Nextflow. It provides a standardized set of best practices, guidelines, and templates for building and sharing bioinformatics pipelines.
44

docs/nf_develop/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# Develop nf-core
22

33
Nextflow provides a powerful way to develop pipelines. However, it does not provide standards for how pipelines should be developed. This gap has led to the establishment of pipeline registries, such as [nf-core](https://nf-co.re/), with tools and implementation guidelines that provide support and standards for pipeline development.
44

0 commit comments

Comments
 (0)