Improve the layout of the intro and outro materials for Side Quests #727

vdauwera · 2025-11-25T15:17:45Z

Toying with some ideas to improve the layout of the Side Quests.

Distinguish and highlight Learning goals and Prerequisites with subheadings in the intro part
Rename the warmup section (Get started) and give it more structure
- Open the training codespace
- Move into the project directory
- Explore the materials
- Scenario
- Readiness checklist
Summary: associate the code examples with the "what you've learned" recaps and streamline the AI-generated text. Some of it is repetitive.
Add/rework "What's next?" sections

netlify · 2025-11-25T15:18:06Z

✅ Deploy Preview for nextflow-training ready!

Name	Link
🔨 Latest commit	`cb60d65`
🔍 Latest deploy log	https://app.netlify.com/projects/nextflow-training/deploys/692f4f1c901406000892bb5c
😎 Deploy Preview	https://deploy-preview-727--nextflow-training.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

we don't need to title these code boxes, it's overkill

Will use this as a model for the others

Included a few TODO comments that are non-blocking for the PR, just ideas for future improvement

Still need to do the Summary section on scripting patterns but kid 2 wants me to play Roblox with her

…bdir

…io/training into gvda-sidequests-layout

github-actions · 2025-12-02T20:38:17Z

Nextflow linting complete!

❌ 5 files had 33 errors
✅ 143 files had no errors

^{💡 Tip: Click filename locations to go directly to that code.}

View all 33 issues

Type	Location	Message
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:11:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/sayHello.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:12:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/convertToUpper.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:13:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/collectGreetings.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:24:5	`sayHello` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:27:5	`convertToUpper` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:27:20	`sayHello` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:30:5	`collectGreetings` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:30:22	`convertToUpper` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:33:5	`collectGreetings` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:36:11	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:11:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/sayHello.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:12:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/convertToUpper.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:13:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/collectGreetings.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:14:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/cowpy.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:24:5	`sayHello` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:27:5	`convertToUpper` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:27:20	`sayHello` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:30:5	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:30:22	`convertToUpper` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:33:5	`cowpy` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:33:11	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:36:20	`cowpy` is not defined
Error	hello-nf-core/solutions/core-hello-part2/nextflow.config:154:17	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/core-hello-part2/conf/test_full.config'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:1:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/validate_name.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:2:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/say_hello.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:3:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/timestamp_greeting.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:11:24	`VALIDATE_NAME` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:12:24	`SAY_HELLO` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:13:26	`TIMESTAMP_GREETING` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:1:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/say_hello_upper.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:2:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/reverse_text.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:10:20	`SAY_HELLO_UPPER` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:11:23	`REVERSE_TEXT` is not defined

github-actions · 2025-12-02T20:42:38Z

Nextflow linting complete!

❌ 5 files had 33 errors
✅ 143 files had no errors

^{💡 Tip: Click filename locations to go directly to that code.}

View all 33 issues

Type	Location	Message
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:11:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/sayHello.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:12:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/convertToUpper.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:13:1	Invalid include source: '/home/runner/work/training/training/hello-nextflow/solutions/5-hello-containers/modules/collectGreetings.nf'
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:24:5	`sayHello` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:27:5	`convertToUpper` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:27:20	`sayHello` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:30:5	`collectGreetings` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:30:22	`convertToUpper` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:33:5	`collectGreetings` is not defined
Error	hello-nextflow/solutions/5-hello-containers/hello-containers-2.nf:36:11	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:11:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/sayHello.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:12:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/convertToUpper.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:13:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/collectGreetings.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:14:1	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/composable-hello/modules/cowpy.nf'
Error	hello-nf-core/solutions/composable-hello/hello.nf:24:5	`sayHello` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:27:5	`convertToUpper` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:27:20	`sayHello` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:30:5	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:30:22	`convertToUpper` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:33:5	`cowpy` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:33:11	`collectGreetings` is not defined
Error	hello-nf-core/solutions/composable-hello/hello.nf:36:20	`cowpy` is not defined
Error	hello-nf-core/solutions/core-hello-part2/nextflow.config:154:17	Invalid include source: '/home/runner/work/training/training/hello-nf-core/solutions/core-hello-part2/conf/test_full.config'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:1:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/validate_name.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:2:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/say_hello.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:3:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/timestamp_greeting.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:11:24	`VALIDATE_NAME` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:12:24	`SAY_HELLO` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/greeting.nf:13:26	`TIMESTAMP_GREETING` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:1:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/say_hello_upper.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:2:1	Invalid include source: '/home/runner/work/training/training/side-quests/solutions/workflows_of_workflows/modules/reverse_text.nf'
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:10:20	`SAY_HELLO_UPPER` is not defined
Error	side-quests/solutions/workflows_of_workflows/workflows/transform.nf:11:23	`REVERSE_TEXT` is not defined

pinin4fjords

Nice work!

The standardized structure for intro/outro sections is a clear improvement - having consistent "Learning goals", "Prerequisites", and "Get started" sections across all side quests will help learners know what to expect.

Adding code snippets to the Summary sections is particularly useful - makes them work as quick reference rather than just recap text.

One small note: "What's next?" uses ## while the intro subsections use ###, so the ending ends up more prominent than the beginning. Not a blocker, just flagging in case it wasn't intentional.

vdauwera · 2025-12-03T13:56:13Z

Thanks @pinin4fjords ! Yep that ## was intentional, it's so the what's next stands out vs the summary.

Restructure the layout of the intro and outro for Side Quests

bf50cc1

vdauwera self-assigned this Nov 25, 2025

vdauwera added the side quests label Nov 25, 2025

vdauwera added 26 commits November 25, 2025 10:23

Fix formatting

fd98e1d

Argh stupid formatting

c07639f

hmmmmppphhh

2539f0f

Experimenting some more with the list formatting

3e50790

it should be groovy not nextflow

fa362bb

i swear it's like talking to a genie

5f44e88

i think I got it

e99779f

Tone down the subheadings in the Get started section

374fe00

streamlined

6c88fdb

we don't need to title these code boxes, it's overkill

Metadata layout/intro/outro should be all set now

0335b25

Will use this as a model for the others

Updated split & group

6f2c5d3

Fix formatting

e991638

The auto-style-correct keeps borking my spacing goddammit

7740bd7

THERE ARE FOUR SPACES

09043c3

it's like dark incantations

a4b7221

metadata is correct, now fix split & group

ec9f5e2

list getting parsed ok, now let's get the groovy highlighting

c4e86d7

please let this work

f1e9b9e

apply new layout to Files side quest

8c8db02

Applied the new layout to WoW

234289c

Improve snippets in WwF

f4d4b01

small tweak

e6aa009

Applied new layout to debugging SQ

c3e0cb2

Included a few TODO comments that are non-blocking for the PR, just ideas for future improvement

oops this got left out

f3a0d9b

Applied layout to nf-test and first part of scripting patterns

66da440

Still need to do the Summary section on scripting patterns but kid 2 wants me to play Roblox with her

finish the summary section of scripting patterns and move ideas to su…

2568c81

…bdir

vdauwera mentioned this pull request Dec 2, 2025

Improve layout of Side Quests #728

Closed

vdauwera marked this pull request as ready for review December 2, 2025 19:08

vdauwera added 3 commits December 2, 2025 14:08

Merge branch 'master' into gvda-sidequests-layout

4f61dad

Added missing syntax examples from lesson

8a7ba4e

Merge branch 'gvda-sidequests-layout' of https://github.com/nextflow-…

1314d58

…io/training into gvda-sidequests-layout

Merge branch 'master' into gvda-sidequests-layout

cb60d65

vdauwera requested review from mribeirodantas and pinin4fjords December 2, 2025 20:42

pinin4fjords approved these changes Dec 3, 2025

View reviewed changes

vdauwera merged commit ec0f143 into master Dec 3, 2025
9 checks passed

vdauwera deleted the gvda-sidequests-layout branch December 3, 2025 13:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve the layout of the intro and outro materials for Side Quests #727

Improve the layout of the intro and outro materials for Side Quests #727

Uh oh!

vdauwera commented Nov 25, 2025 •

edited

Loading

Uh oh!

netlify bot commented Nov 25, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 2, 2025

Uh oh!

github-actions bot commented Dec 2, 2025

Uh oh!

pinin4fjords left a comment •

edited

Loading

Uh oh!

vdauwera commented Dec 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Improve the layout of the intro and outro materials for Side Quests #727

Improve the layout of the intro and outro materials for Side Quests #727

Uh oh!

Conversation

vdauwera commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for nextflow-training ready!

Uh oh!

github-actions bot commented Dec 2, 2025

Uh oh!

github-actions bot commented Dec 2, 2025

Uh oh!

pinin4fjords left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vdauwera commented Dec 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vdauwera commented Nov 25, 2025 •

edited

Loading

netlify bot commented Nov 25, 2025 •

edited

Loading

pinin4fjords left a comment •

edited

Loading