diff --git a/CONTRIBUTING.Qmd b/CONTRIBUTING.Qmd index be1aad8..670c4bf 100644 --- a/CONTRIBUTING.Qmd +++ b/CONTRIBUTING.Qmd @@ -8,7 +8,7 @@ The [Contributor Covenant Code of Conduct can be found here](https://github.com/ To make a new cheatsheet, you can create a Rmd or md in the top of the repository. GitHub Actions will automatically render the cheatsheet as a PNG which will be saved to the `docs` folder. -There are two style options: `css/ITN_style.css` and `css/OTTR_style.css`. +There are two style options: `css/ITN_style.css` and `css/OTTR_style.css`. Specify this in the yaml header: @@ -83,4 +83,4 @@ To get icons you can use the following: ## Adding cheatsheets to main page - Add information about the cheatsheet (and links) to the `gallery.yml` file -- Check render of index.Qmd \ No newline at end of file +- Check render of index.Qmd diff --git a/chunks/create_ottr_header.md b/chunks/create_ottr_header.md index a7843e7..193e7a4 100644 --- a/chunks/create_ottr_header.md +++ b/chunks/create_ottr_header.md @@ -6,3 +6,6 @@
Download cheatsheet
**Last updated: `r format(Sys.time(), '%B %d, %Y')`**
+ + + diff --git a/chunks/enable_actions.md b/chunks/enable_actions.md index 742c063..7bf1ecf 100644 --- a/chunks/enable_actions.md +++ b/chunks/enable_actions.md @@ -2,11 +2,13 @@ In your OTTR repository, go to **Settings** in the top navigation tabs `r config::get("settings")` - Go to **Actions** (General) in the side navigation `r config::get("actions")` + Go to **Actions** in the menu on the left side `r config::get("actions")` - Under **Workflow permissions** + Select **General** just below **Actions** -1. Select **Read and write permissions** + Scroll down to **Workflow permissions** + +1. Ensure **Read and write permissions** is selected 2. Check **Allow GitHub Actions to create and approve pull requests** diff --git a/chunks/secrets.md b/chunks/secrets.md index dec3030..275f977 100644 --- a/chunks/secrets.md +++ b/chunks/secrets.md @@ -2,6 +2,8 @@ In your OTTR repository, go to **Settings** in the top navigation tabs `r config::get("settings")` +Note that this is different from your profile settings where you made your token. + Go to **Secrets and variables** in the side navigation `r config::get("secrets")` Click on **Actions** @@ -16,4 +18,10 @@
-[Click here to see GitHub documentation on setting repository secrets.](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) + + + Click here to see GitHub documentation on setting repository secrets. + diff --git a/chunks/starter_template.md b/chunks/starter_template.md index 98edaa2..1395499 100644 --- a/chunks/starter_template.md +++ b/chunks/starter_template.md @@ -1,16 +1,18 @@ + + ## Log into GitHub or make a GitHub profile if you are new to GitHub - Go to https://github.com/ + Go to [github.com](https://github.com) Sign up for GitHub if you haven't already - it's free! Make sure you are logged into GitHub - check at https://github.com/ - you should see your profile in the upper right corner -## Create a repository from the [{TEMPLATE_NAME}]({TEMPLATE_URL}) template +## Create a repository from the {TEMPLATE_NAME} template - Go to {TEMPLATE_URL} + Go to [{TEMPLATE_NAME}]({TEMPLATE_URL}) - In the upper right, _click on_:
Use this template
+ In the upper right, _click on_:
Use this template
Make sure you don't click on the green "Code" button instead! diff --git a/chunks/token.md b/chunks/token.md index 435f059..18b9e9c 100644 --- a/chunks/token.md +++ b/chunks/token.md @@ -2,27 +2,30 @@ Click on your **profile photo** in the upper right `r config::get("profile")` - Go to **Settings** `r config::get("settings")` + Scroll down to **Settings** `r config::get("settings")` - Go to **Developer Settings** in the lower left side navigation `r config::get("settings")` + Scroll down in the menu on the left side to **Developer Settings** in the lower left side navigation `r config::get("settings")` - Click on **Personal access tokens** `r config::get("token")` + Scroll down in the left side menu on the left side to **Personal access tokens** `r config::get("token")` Select **Tokens (classic)** - Click gray "Generate new token" button + Click very light gray button that says
Generate new token ▾
(upper right) Select **Generate new token (classic)** - Confirm your access + Confirm your access if you have two factor authentication set up (you will be asked to submit a code or something similar) - Name your token GH_PAT + Name your token GH_PAT in the "Note" section - Underneath **Select Scopes**, *check both* **repo** and **workflow** (all check boxes in those sections) +Note that your token will expire based on the date that you set in the Expiration section. You will have to complete this process again when your token expires. GitHub will let you know as you will get an error about credentials. It is a good idea to use the default settings. - Click:
Generate token
+ Underneath **Select Scopes** (where the check boxes are), check **repo** (so everything under it is checked) and **workflow** + + Click:
Generate token
+ + Copy the **personal access token** `r config::get("copy")` and save somewhere safe and private. **Please note that you cannot retrieve this personal access token again later from GitHub.** If you lose it, you just need to complete this process again. - Copy the **personal access token** `r config::get("copy")` and save somewhere safe and private
diff --git a/css/OTTR_style.css b/css/OTTR_style.css index a4217df..fbff45b 100644 --- a/css/OTTR_style.css +++ b/css/OTTR_style.css @@ -29,11 +29,26 @@ input[type="checkbox"] { font-size: 16px; margin: 4px 2px; transition-duration: 0.4s; - cursor: pointer; } /*------------- png boxes button style---------------- */ + +.github_gray_button { + border-radius: 8px; + border: 1px solid #black; + background: #E8E8E8; + color: black !important; + box-shadow: 0 12px 16px 0 rgba(0,0,0,0.24), 0 17px 50px 0 rgba(0,0,0,0.19); + padding: 8px 16px; + text-align: center; + text-decoration: none; + display: inline-block; + font-size: 16px; + margin: 4px 2px; + transition-duration: 0.4s; +} + .png_button { position: absolute; /*----placement of button--*/ top: 20px; /*----placement of button--*/ @@ -52,6 +67,8 @@ input[type="checkbox"] { cursor: pointer; } + + /*------------- timestamp style---------------- */ .time { margin-top:60px; diff --git a/ottr_course.Rmd b/ottr_course.Rmd index ce3ebf5..e0c07f7 100644 --- a/ottr_course.Rmd +++ b/ottr_course.Rmd @@ -48,6 +48,6 @@ ottrpal::borrow_chapter( ottrpal::borrow_chapter( doc_path = "chunks/create_ottr_footer.md", tag_replacement = list( - "{AUTHORS}" = "Kate Isaac wrote the content and created the original styling, Carrie Wright did the css styling and Carrie Wright and Candace Savonen did the publishing engineering for the cheatsheet." + "{AUTHORS}" = "Kate Isaac wrote the content and created the original styling, Carrie Wright did the css styling and Carrie Wright and Candace Savonen did the publishing engineering for the cheatsheet. Padmashri Saravanan and Allissa Dillman from [BioDataSage](https://www.biodatasage.com/) worked with Carrie Wright to review and improve the cheatsheet." )) ``` diff --git a/ottr_quarto_website.Rmd b/ottr_quarto_website.Rmd index 8fcbe67..1941630 100644 --- a/ottr_quarto_website.Rmd +++ b/ottr_quarto_website.Rmd @@ -48,6 +48,6 @@ ottrpal::borrow_chapter( ottrpal::borrow_chapter( doc_path = "chunks/create_ottr_footer.md", tag_replacement = list( - "{AUTHORS}" = "Kate Isaac wrote the content and created the original styling, Carrie Wright did the css styling and Carrie Wright and Candace Savonen did the publishing engineering for the cheatsheet." + "{AUTHORS}" = "Kate Isaac wrote the content and created the original styling, Carrie Wright did the css styling and Carrie Wright and Candace Savonen did the publishing engineering for the cheatsheet. Padmashri Saravanan and Allissa Dillman from [BioDataSage](https://www.biodatasage.com/) worked with Carrie Wright to review and improve the cheatsheet." )) ```