Prerequisites for using OTTR

First please take a look at our code of conduct if you wish to contribute to OTTR.

OTTR relies on R Markdown and GitHub actions. You do not need to be an expert about either R Markdown or GitHub to get started using OTTR, as we will guide you through the process! However, we recommend reading up a bit about both to better understand how they work in general before diving in to our guide. These readings only take a few minutes.

Please check out these resources if you are not familiar with R Markdown:

If you are not familiar with Git and GitHub, we recommend going through these chapters from our Reproducibility courses for a quick orientation:

We have two recommended ways of writing content based on your comfort and interest level in using Git and GitHub:

  • OTTR Entry Level - if you do not have interest in diving into GitHub, use this version. It is done completely through the GitHub web browser.
  • OTTR Advanced - If you are already familiar with Git and GitHub or are interested in starting to use it, we recommend this method. It will require a bit more learning, but Git and GitHub will be a great skill set for you to utilize; both for OTTR purposes and elsewhere for version control!

If you choose to use our OTTR Advanced guidance, you will need a method for working with git.

If you do not have a method of working with Git already it is recommended you use a Git client to help you manage your branches more easily. Install GitKraken for a handy way to manage your course locally.


Starting a new OTTR course

1. Create a repository from this template

In the upper right of the landing page for this repository, click the green Use this template button and follow the steps to set up your course’s GitHub repository.

*If you want to use OTTR Website or a different spin off go to that respective repository:

Where is the Use this template button?

2. Name your repository and fill in a short description

Creating new course repository

3. Make sure your course is set to public for all GitHub actions to work

In particular, the rendered preview on pull requests won’t work, but you can alternatively preview the content by re-rendering locally if you want to keep your course private. We will cover this later.

4. Click the Create repository from template button

Now you are ready to create your repository. Upon creating your repository, issues for getting your course started will be automatically filed in your repository. Go to Issues and you can follow them along to get set up.

5. Add jhudsl-robot as a collaborator

*You can skip this step if your course is in the jhudsl organization.

The GitHub actions in this repository need permissions to fully function. To this end, you need to add the jhudsl-robot as a collaborator on your repository with write permissions.

In your repository, go to your Settings > Collaborators & Teams and click on Add people. In the pop up window, search for and add jhudsl-robot.

Choose the write option then click Add jhudsl-robot to this repository.

6. Set up your GitHub personal access token

The OTTR robots need permissions to run some of the actions.

To give them permission for all the actions, you need to set a GitHub secret we will call GH_PAT. Go to Settings > Secrets and scroll down to Repository secrets. Read more about GitHub secrets here if you have general questions.

If you have organization admin privileges and plan on making multiple courses with OTTR, you can set GH_PAT as an organization secret so you don’t have to do this again. You only need to do this once as an organization (if this course is under jhudsl you don’t need to do this step).

  • Click New repository secret/New organization secret button.
  • Under Name you must use GH_PAT.
  • For Secret: Create a personal access token following these instructions. Underneath Select scopes, check both repo and workflow. Then copy the PAT and save as the secret. Your GitHub actions should all be able to run smoothly now.

7. Set up GitHub pages

In your repository, go to Settings > Pages.

Change pages settings

  • Under Source, pick the drop down menu and pick main and /docs.
  • Then click Save.
  • Lastly, check the box that says Enforce HTTPS at the bottom of this page.

Enforce HTTPS

The URL for your material will be your main github pages url + / + your OTTR repository name and it will be displayed underneath your Settings > Pages if you aren’t sure.

By default, Github pages is sent to a url that looks like username.github.io where username is either your individual user name or your organization’s name. However, you can set your GitHub pages URL to be custom (like we have in this example here - jhudatascience.org). So it is likely your pages URL is something like username.github.io/your_ottr_repository_name.

For more information about GitHub pages we recommend you reference the GitHub documentation here.

* Warning: if you go to your pages url right now (before you’ve pushed any file changes) you might see a 404 error because nothing has been triggered to be rendered. You can check your url pages after you file your first pull request (which we will guide you through in the next section).

8. Set up branch rules

* Don’t set these settings right away! Wait a few minutes after starting your repository.

Go to Settings > Branches and click Add rule. This is only possible if you have GitHub Pro, Team, or Enterprise access. We recommend seeing if your organization can give you access if you do not already have access. To get this access through your organization, you will need to transfer ownership of your repo to your organization. See here about how to do this.

Add branch rule

For Branch name pattern, put main.

Put main for branch name pattern

Protect the main branch:
Then check the box that says Require pull requests before merging.

* Note that if the user whose personal access token does not have admin privileges for step 6. Set up your GitHub personal access token, then you will need to skip this setting.

Make sure branches are updated:
- Check the box that says Require status checks to pass before merging. - Underneath this also check the box that says Require branches to be up to date before merging.

Branch settings

After setting up these new branch items, click Create and Save changes.

9. Enroll your repository for OTTR updates

This original course template: https://github.com/jhudsl/OTTR_Template is always a work in progress. We are working on adding more features and smoothing out bugs as we go (this is also why your feedback is greatly appreciated).

When updates are made to files that aren’t specific to the course content but instead run checks and other processes in the original repository, pull requests are filed automatically to any downstream repositories made from this template.

To enroll in these automatic update pull requests, the new course’s repository name will need to be added to this file in the original template

  • Got to the respective file: .github/sync.yml of the OTTR template repository you created your repository from:
  • Add your repository’s name where it says #NEW REPO HERE#, being careful to indent the same amount as the other repositories listed.
  • Choose Create a new branch for this commit and start a pull request. Name the branch what you like.
  • Name the commit Add new repository to sync
  • Click Propose changes.
  • See this guide for any questions you have about creating a pull request from your forked repository.
  • Write a short pull request description describing that you are adding a new repository to the sync.yml file.
  • Click Create Pull Request
  • Request @cansavvy as a reviewer.

If your new course doesn’t need some of the functionality of these files or you find the automatic updates bothersome, you can feel free to use this guide to tailor which files you want updates for. If you have any questions about the implications of any of these updates or files, please tag @cansavvy.

Methods of writing content

Again we have two recommended ways of writing content based on your comfort and interest level in using Git and GitHub:

Jump to OTTR Entry Level instructions here Jump to OTTR Advanced instructions here

Now you are ready to start writing content!