website_setup.Rmd

---
title: |
  <center> <u> OTTR Website </u></center>
  <center> <p style = "color:#986753;"> Setup </p></center>
date: "Last updated: `r format(Sys.time(), '%B %d, %Y')`"
output: html_document
css: style.css
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```


## Create your OTTR repository from the [OTTR_Template_Website repository](https://github.com/jhudsl/OTTR_Template_Website)

<input type="checkbox">  In the upper right, _click on_: <div class = "github_button"><a href="https://github.com/new?template_name=OTTR_Template_Website&template_owner=jhudsl"> Use this template</a></div>

<input type="checkbox">  Set your repo to **Public**

## Enable workflow actions

<input type="checkbox">  In your OTTR repository, go to **Settings** in the top navigation tabs <img src="resources/icons/settings_gear.png" alt="settings icon" class = icon>

<input type="checkbox">  Go to **Actions** (General) in the side navigation <img src="resources/icons/actions.png" alt="actions icon" class = icon>

<input type="checkbox">   Under **Workflow permissions**

1. <input type="checkbox"> Select **Read and write permissions**

2. <input type="checkbox">  Check **Allow GitHub Actions to create and approve pull requests**

3. <input type="checkbox">  Click **Save**

## Set up your GitHub personal access token

A. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)

<input type="checkbox"> Click on your **profile photo** in the upper right <img src="resources/icons/profile_photo.png" alt="profile icon" class = icon>

<input type="checkbox"> Go to **Settings**<img src="resources/icons/settings_gear.png" alt="settings icon" class = icon>

<input type="checkbox"> Go to **Developer Settings** in the side navigation <img src="resources/icons/developer_settings.png" alt="developer settings icon" class = icon>

<input type="checkbox"> Select **Generate new token (classic)** <img src="resources/icons/personal_tokens.png" alt="personal access token icon" class = icon>

<input type="checkbox"> Underneath **Select Scopes**, *check both* **repo** and **workflow**

<input type="checkbox"> Click: <div class = "github_button"><a href="https://github.com/settings/tokens/new"> Generate Token</a></div>

<input type="checkbox"> Copy the **personal access token** <img src="resources/icons/copy.png" alt="copy icon" class = icon>

B. [Save the copied personal access token as a repository secret](https://docs.github.com/en/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository)

<input type="checkbox"> In your OTTR repository, go to **Settings** in the top navigation tabs <img src="resources/icons/settings_gear.png" alt="settings icon" class = icon>

<input type="checkbox"> Go to **Secrets and variables** in the side navigation <img src="resources/icons/secrets_and_variables.png" alt="secrets icon" class = icon>

<input type="checkbox"> Click on **Actions**

<input type="checkbox"> Under **Repository secrets**, click on <div class = "github_button"> New repository secrets </div>

<input type="checkbox"> Under **Name**, enter **GH_PAT**

<input type="checkbox"> For **Secret**, paste your copied personal access token

<input type="checkbox"> Click on: <div class = "github_button"> Add secret </div>

## Set up GitHub Pages

<input type="checkbox"> In your OTTR repository, go to Settings in the top navigation tabs <img src="resources/icons/settings_gear.png" alt="secrets icon" class = icon>

<input type="checkbox"> Go to **Pages** in the side navigation <img src="resources/icons/pages.png"  alt="pages icon" class = icon>

<input type="checkbox"> In the **Build and deployment section**

  1. <input type="checkbox"> Under **Source**, select **Deploy from a branch**
  2. <input type="checkbox"> Under **Branch**, pick **main** and choose **/docs**, and click **Save**

<input type="checkbox"> at the bottom of the page, check **Enforce HTTPS**

## Enroll your OTTR repository for template updates

<input type="checkbox"> Refer to our Template Updates Cheatsheet


<center>
<a href="https://ottrproject.org">
  <img src="resources/images/basic_otter_water.png" width = 30%>
</a>
</center>