Skip to content

Dev Container and CWL Tutorial #623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 30, 2025

Conversation

paulineHans
Copy link
Contributor

A tutorial on Dev Containers in conjunction with CWL. A detailed and simple example shows how to create a Dev Container in VS Code and how to create a CWL workflow within the Docker Container used. The tutorial not only contains step-by-step instructions, but also theoretical background and explanations, as well as links to further information.

@paulineHans
Copy link
Contributor Author

Hey, @caroott and @Brilator could you take a look at it and give me some feedback on whether anything needs to be changed and whether it meets your requirements?

@Brilator
Copy link
Member

Thanks, @paulineHans. Goes in the right direction and helps with what I was trying to do in parallel #619.

However, I would kindly ask you to update your fork first and open a new PR. ;)

Screenshot 2025-07-24 at 16 10 09

We have completely restructured the knowledge base in the past year and based it on a new framework (astro starlight). See README and contribution guide for details.

@paulineHans
Copy link
Contributor Author

Hello @Brilator, the tutorial has been adapted and revised. Is everything OK now?

@Brilator
Copy link
Member

Hi @paulineHans, thanks, looks much better.
I've added some extras for proper code highlighting, file naming (titles), step components etc. in the linked PR.
Maybe you can also pick up some features from this guide (boxes, file trees etc) https://nfdi4plants.github.io/nfdi4plants.knowledgebase/cwl/fairify-scripts/ (although this is also work in progress).

And please make sure to run npm run start or rpm run build to test locally. There wer some slight warnings.

@paulineHans
Copy link
Contributor Author

Hi @Brilator, i added a few HTML elements to make it look nicer and tested it with astro and npm run start. The warnings have been fixed. Please take another look and let me know what you think is still missing or needs to be changed.

@Brilator
Copy link
Member

Hi, I actually did most of that already for you paulineHans#1

I'd still suggest to add filenames as titles to the ``` code blocks. And maybe add a file tree with the component, where you show how the files are structured (in an ARC).
Thanks

@paulineHans
Copy link
Contributor Author

Hi, @Brilator sorry about that. I've added everything, hope everything is fine now, otherwise feel free to contact me again. The ARC is public and linked in the tutorial. :)

@Brilator Brilator merged commit f281a81 into nfdi4plants:main Jul 30, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants