Skip to content

Commit 881e16e

Browse files
Initial commit
0 parents  commit 881e16e

File tree

226 files changed

+37007
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

226 files changed

+37007
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Add your new website to syncs/OTTR updates
3+
about: Provide information about your new website (which uses the OTTR Website template) so that we can enroll it in OTTR updates
4+
title: ''
5+
labels: ''
6+
assignees: |
7+
kweav
8+
carriewright11
9+
10+
---
11+
12+
## What is the GitHub link for your new repository?
13+
14+
<!-- The GitHub link for this repository is https://github.com/ottrproject/OTTR_Template_Website. Please make sure the link you provide starts with github.com! -->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Update your website's info for syncs/OTTR updates
3+
about: Provide information about your moved/renamed website (which uses the OTTR Website template) so that it can continue to be enrolled in OTTR updates
4+
title: ''
5+
labels: ''
6+
assignees: |
7+
kweav
8+
carriewright11
9+
10+
---
11+
12+
<!-- Remove headings if they are not applicable to the changes/updates you made for your repo-->
13+
14+
## Please provide the new GitHub link to your repository
15+
16+
<!-- The GitHub Link for this repository is https://github.com/ottrproject/OTTR_Template_Website. Please make sure that the link you provide starts with github.com! -->
17+
18+
## If you can, please provide the old GitHub link before your repository was renamed or moved.
19+
20+
<!-- This is optional, but would be nice if you could provide it for us -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Website Template Feature Request
3+
about: Suggest an idea for the website templates
4+
title: ''
5+
labels: ''
6+
assignees: |
7+
kweav
8+
carriewright11
9+
10+
---
11+
12+
## Is your feature request related to a problem? Please describe.
13+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
14+
15+
## Describe the solution you'd like
16+
<!-- A clear and concise description of what you want to happen. -->
17+
18+
## Describe alternatives you've considered
19+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
20+
21+
## Additional context
22+
<!-- Add any other context or screenshots about the feature request here. -->
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Website Template Problem Report
3+
about: Create a report to help improve the template and its documentation
4+
title: Problem
5+
labels: bug
6+
assignees: |
7+
kweav
8+
carriewright11
9+
10+
---
11+
12+
## Describe what is not working with the template or is unclear in the documentation
13+
<!-- A clear and concise description of what the bug is. -->
14+
15+
## Please link to the specific website repository you are working on
16+
17+
## To Reproduce
18+
<!-- Steps to reproduce the behavior:
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error -->
23+
24+
## Expected behavior
25+
<!-- A clear and concise description of what you expected to happen. -->
26+
27+
## Github actions links
28+
<!-- If applicable please link to the Github actions that has failed. -->
29+
30+
## Screenshots
31+
<!-- If applicable, add screenshots to help explain your problem. -->
32+
33+
## Additional context
34+
<!-- Add any other context about the problem here. -->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Add new repository to sync
3+
about: Enroll your repository for OTTR updates
4+
title: OTTR Updates Enrollment
5+
labels: ''
6+
assignees: cansavvy
7+
---
8+
9+
Added __ repository to sync.yml in order to enroll in OTTR updates.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: New Content or Feature
3+
about: New Content or Feature Update
4+
title: General Update
5+
labels: ''
6+
assignees:
7+
---
8+
9+
10+
<!--This PR Template was modified from https://github.com/AlexsLemonade/OpenPBTA-analysis/blob/master/.github/PULL_REQUEST_TEMPLATE.md-->
11+
12+
### Purpose/implementation Section
13+
14+
#### What changes are being implemented in this Pull Request?
15+
16+
17+
18+
#### What was your approach?
19+
20+
21+
22+
#### What GitHub issue does your pull request address?
23+
24+
25+
26+
### Tell potential reviewers what kind of feedback you are soliciting.
27+
28+
29+
30+
### New Content Checklist
31+
32+
- [ ] New content/page is in an Rmd file with [this kind of format and headers](https://github.com/ottrproject/OTTR_Template_Website/blob/main/editing.Rmd).
33+
34+
- [ ] Website successfully re-renders and any new content files have been added to the `_site.yml` file.
35+
36+
- [ ] [Spell check runs successfully](https://www.ottrproject.org/customize-robots.html#Spell_checking)).
37+
38+
- [ ] Any newly necessary packages that are needed have been added to the [Dockerfile and image](https://www.ottrproject.org/customize-docker.html).
39+
40+
- [ ] Images are in the [correct format for rendering](https://www.ottrproject.org/writing_content_courses.html#set-up-images).
41+
42+
- [ ] Every new image has [alt text and is in a Google Slide](https://www.ottrproject.org/writing_content_courses.html#Accessibility).
43+
44+
- [ ] Each slide is described in the notes of the slide so learners relying on a screen reader can access the content. See https://lastcallmedia.com/blog/accessible-comics for more guidance on this.
45+
46+
- [ ] The color palette choices of the slide are contrasted in a way that is friendly to those with color vision deficiencies.
47+
You can check this using [Color Oracle](https://colororacle.org/).
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
**Note these steps are only pertinent if you are setting up this website outside of the jhudsl organization**
3+
4+
For more information on these settings see instructions in the [getting started on ottrproject.org](https://www.ottrproject.org/getting_started.html#6_Set_up_your_GitHub_personal_access_token).
5+
6+
It's important that these are set up and named exactly what they are below in order for Github actions to work correctly.
7+
8+
To set up these repository secrets, on your repository's main Github page, go to `Settings` and scroll down to see `Secrets` on the left side menu bar.
9+
10+
- [ ] Set `GH_PAT`
11+
`Name`: `GH_PAT`
12+
`value`: A personal access token [following these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token).
13+
Underneath `Select scopes`, check both `repo` and `workflow`.
14+
Then copy the PAT and save as the value.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
For more information on these settings see instructions in [Starting a new OTTR website](https://www.ottrproject.org/getting_started.html#starting-a-new-ottr-course).
3+
4+
- [ ] This website repository is set to `public`.
5+
6+
- [ ] [Github secret `GH_PAT` has been set](https://www.ottrproject.org/getting_started.html#6_Set_up_your_GitHub_personal_access_token)
7+
`Name`: `GH_PAT`
8+
`value`: A personal access token [following these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token).
9+
Underneath `Select scopes`, check both `repo` and `workflow`.
10+
Then copy the PAT and save as the value.
11+
12+
- [ ] GitHub pages is turned on
13+
- [ ] Go to `Settings` > `Pages`. Underneath `Source`, choose `main` for the branch and select the `docs` folder. Then click `Save`.
14+
- [ ] Check `Enforce HTTPS`.
15+
16+
- [ ] [Set branch protections settings](https://www.ottrproject.org/getting_started.html#8_Set_up_branch_rules)
17+
- [ ] `main` branch has been set up:
18+
- [ ] `Require pull request reviews before merging` box is checked.
19+
- [ ] `Require status checks to pass before merging` box is checked.
20+
- [ ] Underneath that `Require branches to be up to date before merging` box is checked.
21+
- [ ] Click `Save` at the bottom of the page!
22+
23+
- [ ] [Customize GitHub actions](https://www.ottrproject.org/customize-robots.html) for what you will need in this website.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
[Follow the instructions here in ottrproject.org](https://www.ottrproject.org/editing_website.html) for details on how to start editing your OTTR website.
3+
4+
The following files need to be edited to get this new website started!
5+
6+
### Files that need edited upon creating a new website.
7+
8+
- [ ] `README.md` - Fill in the README with the title of the website, a brief description of the website, and any other details that would be useful for anyone who encounters your website.
9+
- [ ] `index.Rmd` - Update the `title` field. Since this Rmd file serves as the website's landing page, include any information you believe will be beneficial for visitors upon their arrival.
10+
11+
12+
### Files that need to be edited upon adding each new page.
13+
14+
- [ ] `_site.yml` - Include the title of your newly created page in the `text` field, and insert the corresponding html file name into the `href` field.
15+
16+
### Picking a style
17+
18+
See more [about customizing style on this page in the guide](https://www.ottrproject.org/customize-style.html).
19+
By default this website template will use the jhudsl data science lab style. However, you can customize and switch this to another style set.
20+
21+
#### Using a style set
22+
23+
[Read more about the style sets here](https://www.ottrproject.org/customize-style.html#Using_a_style_set).
24+
25+
- [ ] On a new branch, copy the `style-sets/<set-name>/index.Rmd` and `style-sets/<set-name>/_output.yml` to the top of the repository to overwrite the default `index.Rmd` and `_output.yml`.
26+
- [ ] Copy over all the files in the `style-sets/<set-name>/copy-to-assets` to the `assets` folder in the top of the repository.
27+
- [ ] [Create a pull request](https://www.ottrproject.org/writing_content.html#Open_a_pull_request) with these changes, and double check the rendered preview to make sure that the style is what you are looking for.
28+
29+
### Files that need to be edited upon adding new packages that the book's code uses:
30+
31+
- `docker/Dockerfile` needs to have the new package added so it will be installed. See [instructions](https://www.ottrproject.org/customize-docker.html).
32+
- The code chunk in `index.Rmd` should be edited to add the new package.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
The original template: https://github.com/ottrproject/OTTR_Template_Website is always a work in progress.
3+
We are working on adding more features and smoothing out bugs as we go.
4+
5+
If you want to receive updates from the original template to your website template, you will need to enroll this repository to the template updates by adding it to the `sync.yml` file.
6+
7+
- [ ] [Follow these instructions](https://www.ottrproject.org/getting_started.html#9_Enroll_your_repository_for_OTTR_updates) to enroll your website repository to receive these updates.

0 commit comments

Comments
 (0)