Skip to content
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

add training materials from NE BRR 2023 docker training #903

Merged
merged 27 commits into from
Sep 20, 2024

Conversation

kapsakcj
Copy link
Collaborator

@kapsakcj kapsakcj commented Mar 12, 2024

Setting as a draft for now, since I'd like to add links to the training materials on the main /README.md but wanted to at least get the ball rolling on this PR. Will mark ready for review once that is completed.

I realized we never PR'd this back to the main StaPH-B repo.

@kevinlibuit I would like to get your eyes on these training materials before merging. Happy to make edits where you see necessary.

This PR does the following:

  • adds the Powerpoint slides (PDF) used in lecture
  • markdown document which walks the trainee through the various exercises
  • updates the .gitpod.yml folder to git checkout master instead of main which resolves the issue of checking out the repo upon launching the GitPod (see screenshot of GitPod workspace I just spun up)

image

Pull Request (PR) checklist:

  • Include a description of what is in this pull request in this message.
  • The dockerfile successfully builds to a test target for the user creating the PR. (i.e. docker build --tag samtools:1.15test --target test docker-builds/samtools/1.15 )
  • Directory structure as name of the tool in lower case with special characters removed with a subdirectory of the version number (i.e. spades/3.12.0/Dockerfile)
    • (optional) All test files are located in same directory as the Dockerfile (i.e. shigatyper/2.0.1/test.sh)
  • Create a simple container-specific README.md in the same directory as the Dockerfile (i.e. spades/3.12.0/README.md)
    • If this README is longer than 30 lines, there is an explanation as to why more detail was needed
  • Dockerfile includes the recommended LABELS
  • Main README.md has been updated to include the tool and/or version of the dockerfile(s) in this PR
  • Program_Licenses.md contains the tool(s) used in this PR and has been updated for any missing

@kevinlibuit kevinlibuit self-requested a review September 16, 2024 15:48
@kapsakcj kapsakcj marked this pull request as ready for review September 16, 2024 15:49
@kapsakcj
Copy link
Collaborator Author

kapsakcj commented Sep 16, 2024

I haven't added links to these materials in the main /README.md yet, but can do so in a separate PR. It's more important to get these materials added to the main repo Links have been added, disregard

@kapsakcj
Copy link
Collaborator Author

@erinyoung FYI I'm using this PR to also add a "Training" section to the main readme with links to the materials included with this PR.

This would be a good location to link to the training you led through APHL: https://learn.aphl.org/learn/course/external/view/elearning/355/intermediate-docker-bioinformatics-workshop

We could include as part of this PR or perhaps add in a separate one. Happy to hear your feedback/thoughts on this.

README.md Outdated Show resolved Hide resolved
@erinyoung
Copy link
Contributor

Closes #1044

Copy link
Contributor

@kevinlibuit kevinlibuit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for adding this, @kapsakcj.

One quick note on something I found interesting: I like that you've updated it to checkout master to be more specific, though it seems that the current .gitpod.yml also sets the environment to master by default and may just ignore that checkout main line as there is no main branch to checkout.

@kapsakcj
Copy link
Collaborator Author

You are correct, it's smart enough to know which branch to check out, but the change in this PR just eliminates the error or warning (can't remember which) that occurs upon starting the gitpod environment

@kevinlibuit kevinlibuit merged commit 9cc6d2a into StaPH-B:master Sep 20, 2024
2 checks 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.

4 participants