kweav / test_data_viz Goto Github PK

Follow the instructions here in ottrproject.org for details on how to start editing your OTTR course

The following files need to be edited to get this new course started!

Files that need edited upon creating a new course.

• README.md - Fill in all the { }.
• index.Rmd - title: should be updated.
• 01-intro.Rmd - replace the information there with information pertinent to this new course.
• 02-chapter_of_course.Rmd - This Rmd has examples of how to set things up, if you don't need it as a reference, it can be deleted.

Files that need to be edited upon adding each new chapter (including upon creating a new course):

• _bookdown.yml - The list of Rmd files that need to be rendered needs to be updated. See instructions.
• book.bib - any citations need to be added. See instructions.

Picking a style

See more about customizing style on this page in the guide.
By default this course template will use the jhudsl data science lab style. However, you can customize and switch this to another style set.

Using a style set

Read more about the style sets here.

• 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.
• Copy over all the files in the style-sets/<set-name>/copy-to-assets to the assets folder in the top of the repository.
• Create a pull request with these changes, and double check the rendered preview to make sure that the style is what you are looking for.

Files that need to be edited upon adding new packages that the book's code uses:

• docker/Dockerfile needs to have the new package added so it will be installed. See instructions.
• The code chunk in index.Rmd should be edited to add the new package.

The original 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.

If you want to receive updates from the original template to your course template, you will need to enroll this repository to the template updates by adding it to the sync.yml file.

• Follow these instructions to enroll your course repository to receive these updates.

• Ensure that you have followed these instructions to add the jhudsl-robot as a collaborator to your repository.

For more information on these settings see instructions in Starting a new OTTR course.

• This course repository is set to public.

• Add the jhudsl-robot as a collaborator to your repository..

• Github secret GH_PAT has been set
  Name: GH_PAT
value: A personal access token following these instructions.
  Underneath Select scopes, check both repo and workflow.
  Then copy the PAT and save as the value.

• GitHub pages is turned on

  • Go to Settings > Pages. Underneath Source, choose main for the branch and select the docs folder. Then click Save.
  • Check Enforce HTTPS.

• Set branch protections settings

  • main branch has been set up:
    • Require pull request reviews before merging box is checked.
    • Require status checks to pass before merging box is checked.
      • Underneath that Require branches to be up to date before merging box is checked.
  • Click Save at the bottom of the page!

• Customize GitHub actions for what you will need in this course.

To help users report issues or areas of improvement for your course, you should provide a clear method of feedback for your users to route their concerns through.

• Read this chapter from an OTTR-made course about how to obtain user feedback.

It's also a good idea to collect passive feedback via Google Analytics.

• Read our guide to Google Analytics here.

URL's in this course were just checked and some broken URLs were found.

Number of errors: 1
File where errors are: url checks file here