Workshop Source   Docker   Status
Example Title   GitHub Action badge

Author guidelines

Orchestra workshop

Bioconductor encourages workshop authors to use the Orchestra platform (optional).

The platform requires a Docker image to run reproducible instances of the workshop in the cloud. A pkgdown website is also expected, as a publicly available static website that participants can refer to during the workshop. Both the Docker image and the pkgdown website are automatically built using a GitHub Action workflow provided in a template GitHub repository.

To create a workshop compatible with the Orchestra platform, please follow the instructions below:

  • Navigate to the template GitHub repository seandavi/BuildABiocWorkshop.
  • Click the green button Use this template.
  • Fill the form on the next web page and click the green button Create repository from template.
    • Select the option Public.
  • Update your new workshop repository with your own content following instructions in the page How To Build A Workshop Package.
  • When your workshop repository is ready, open an issue here.
    • Replace the template contents of the issue with the corresponding information for your own workshop.
    • A workshop is ready when the GitHub Action workflow running on the main branch successfully builds the pkgdown website and the Docker image for the workshop.

For an example of successful GitHub Action workflow report, see here.

Note that workshop materials can continue to be updated up after it was added to Orchestra. Updated materials will automatically become available on the Orchestra platform when the GitHub Action workflow completes the build and deployment of the Docker image.

Alternative workshop formats

Workshop authors may also prepare workshops in other formats, e.g.:

  • Screensharing the presenter’s R session.
  • Asking participants to install packages on their own laptops.

However, in any case, we encourage workshop authors to consider whether they expect participants to follow along on their own computer, and to take into account the time needed to setup the required environment on the participants laptops at the start of the workshop.

In doubt, please post your questions on the #biocworkshops channel of the Bioconductor Slack workspace (preferred). Join the Slack workspace using this self-registration link.

Alternatively, contact the organising committee.