alexslemonade / 2023-june-training Goto Github PK

Turn on GitHub pages under Settings > Pages.
Use the default branch and root directory as the Source.

In AlexsLemonade/training-modules, create a new release that ties that material to this specific workshop. We use the convention <year>-<month> for tags and <year> <month> for release titles for Data Lab workshops.

Don't forget to update the _config.yaml file in this repository to point to the correct release.

Require pull requests before merging on the default branch, under Settings > Branches > Branch protection rules. Require at least one approving review.

Finalize the schedule once all content has been completed.

As a reminder, we recommend using htmlpreview in conjunction with {{site.release_tag}} to display rendered versions of R Notebooks that are tied to a specific release in the AlexsLemonade/training-modules.

Remove customization and development instructions from the README.

Link to <url for repository's GitHub pages>/workshop/HOME in the README, as this is where we want most users to start to interact with the repository.

Update the pages that will appear in the header (header_pages:) in _config.yaml. Any page that appears in the header should have a navigation title (nav_title:) in its YAML header.

Revise the course website to reflect the content this workshop will be covering.

For virtual workshops, the areas that need to be updated are:

• The first bulletpoint in virtual-workshop/workshop-structure.md (which becomes workshop/workshop-structure.md)
• The modules we link to in virtual-workshop/workshop-materials.md (which becomes workshop/workshop-materials.md)

• Delete the irrelevant *-workshop folder.
  If your workshop is a virtual workshop, remove the in-person-workshop folder.
  If your workshop is an in-person workshop, remove the virtual-workshop folder.
  • If you're running an in-person workshop, you will not need the virtual-setup folder, either.
• Rename the relevant *-workshop folder to workshop.
  For a virtual workshop, virtual-workshop should be renamed to workshop.
  Changing this folder name will make several links in the repository work –there are instances where we link to a schedule with ../workshop/SCHEDULE.md, for example.

Update workshop/SCHEDULE.md to point to appropriate materials for your workshop.

• Add relative links to PDFs in slides to the schedule.
• We recommend using htmlpreview to display rendered versions of R Notebooks that are tied to a specific release in the AlexsLemonade/training-modules. You can use the {{site.release_tag}} convention used throughout the template.

Update _config.yaml to use values that are relevant for your workshop such as the Docker repository and tag that you will be using for the workshop. We use jekyll variable substitution as part of this template.

Add PDF copies of your slides to slides. Optional: remove the .gitkeep file from slides.

Slides

• Introduction to the workshop
• R/Studio slides
• scRNA-seq slides
• dimension reduction & clustering slides
• cell typing slides