Releases: jhudsl/OTTR_Template
Releases · jhudsl/OTTR_Template
Spell check and borrowing chapters!
Wiki/Documentation updates
cow::borrow_chapter()
function is described: https://github.com/jhudsl/OTTR_Template/wiki/Borrowing-chapters-between-courses- Intro to OTTR exists and is in progress!: https://jhudatascience.org/Intro_to_OTTR/
- Minor update automatic issues and wiki based on various changes over time
Template/style changes:
- None
Github action changes:
- Spell check prints out the results in a comment on the pull request
- Docker image tag is fixed
Docker image updates:
- jhudsl/cow now has
cow::borrow_chapter()
function
What's Changed
- Try adding spelling errors GHA comment by @cansavvy in #371
- Update issues and advice by @cansavvy in #372
Full Changelog: 1.4...1.5
Release v1.4: New name - OTTR
New name: OTTR - Opensource Tools for Training Resources
Template/style changes:
- Issue with big-image.html was fixed.
Github action changes:
- Minor fixes to spell check
Docker image updates:
jhudsl/cow
: Course Organizer and Wrangler now added to the Docker image
What's Changed
- Have spell-check.R ignore the style-sets directory by @cansavvy in #349
- More styles by @carriewright11 in #343
- Fix logic of no changes in render-preview by @cansavvy in #350
- Just a bit of smoothing out of render-preview.yml by @cansavvy in #351
- Update screenshots for Wiki by @cansavvy in #353
- Sync update by @carriewright11 in #355
- Fix assets/big-image.html by @cansavvy in #361
- Prep for OTTR name switch over by @cansavvy in #362
- Add cow to the Docker image by @cansavvy in #363
- Undo unnecessary copying that triggers permissions issue by @cansavvy in #369
Full Changelog: 1.3...1.4
v1.3
Wiki/Documentation updates
- Google doc usage is now described: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Using-Google-Docs-to-solicit-feedback
- We now are using style sets: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Change-Title-&-Customize-style#using-a-style-set
- There's now a system for using releases to publish courses to the public: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Release-a-course-for-public-viewing
- ZoteroBib is encouraged for citations: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Citations
Template/style changes:
- Style-sets are now in effect
Github action changes:
- Fix the fact that GAScript.html should not be in the _output.yml file when transfered to Leanpub
- There's a method of testing sync PRs
- docs/ folder is deleted before refreshing in render-bookdown.yml. This should make things cleaner: #333
- More files you don't need in new courses are deleted in starting-course.yml
- Render preview will tell you if no changes have occurred in the rendering
Docker image updates:
- None
Detailed PR list:
- Update sync.yml by @cansavvy in #314
- Add files to list of those to get removed upon starting new course by @cansavvy in #319
- Get rid of assignment in issue template by @cansavvy in #320
- Add two new automatic issues to starting-course.yml by @cansavvy in #326
- Implement style libraries reorganization by @cansavvy in #327
- Delete docs in GHA before rendering by @cansavvy in #333
- Updates etc for style by @carriewright11 in #334
- Add Advanced Reproducibility to sync.yml by @cansavvy in #335
- Add new repository to sync by @avahoffman in #338
- Add handling for GA script file in output.yml by @cansavvy in #340
- Add a testing version of sync GHA by @cansavvy in #344
- Quick fix add to release testing GHA by @cansavvy in #346
- Add style sets to sync.yml's by @cansavvy in #348
Full Changelog: 1.2.1...1.3
v1.2.1
A docx version of the course is automatically created and uploaded to docs/
! But note that the sync PR will not include an add to the index.Rmd that you will need to make this work.
Add this to the end of your index.Rmd if you would like a docx created:
output:
bookdown::word_document2:
toc: true
---
Wiki/Documentation updates
- Typo fix: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/pull/289/files
- Title yamls are less confusing to set. The template doesn't set them in the Rmd yaml anymore since that doesn't do anything.
- How to set up Google Analytics is added: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Google-Analytics
Template/style changes:
- A Credit table formatting fix: #294
Github action changes:
- A docx version of the course is uploaded and linked to in the render preview comment.
Docker image updates:
- None
v1.2
A docx version of the course is automatically created and uploaded to docs/
!
Wiki/Documentation updates
- Typo fix: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/pull/289/files
- Title yamls are less confusing to set. The template doesn't set them in the Rmd yaml anymore since that doesn't do anything.
- How to set up Google Analytics is added: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Google-Analytics
Template/style changes:
- A Credit table formatting fix: #294
Github action changes:
- A docx version of the course is uploaded and linked to in the render preview comment.
Docker image updates:
- None
v1.1
Wiki/Documentation updates
- More information about adding a repository for receiving template updates has been added: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Receiving-template-updates#how-to-enroll-a-repository-to-receive-template-updates
- A guide about choosing platforms has been added: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Choosing-publishing-platform(s)
- Nifty graphics have been added!
- How to contribute section has been added!
Template/style changes:
- None
Github action changes:
render-bookdown.yml
was re-added to the files to get updates about (in sync.yml).- An automatic issue about adding one's repository to sync.yml has been added to
starting-a-new-course.yml
- issue templates have been added to the sync.yml
- Issue templates for each course have been added so individuals can file ideas and problems
Docker image updates:
- None
v1.0
Wiki/Documentation updates
- Reorganization of the order of sections
- Content creation tips section has been added: https://github.com/jhudsl/DaSL_Course_Template_Bookdown/wiki/Content-creation-tips
Template/style changes:
- The About.Rmd file now has the title of the course
- The about authors section is not numbered
- Removed the session info header since it will not have the typically headings
Github action changes:
- A delay has been added to
delete-preview.yml
so that it properly deletes preview branches that may not be done processing
Docker image updates:
- None
Pre-release of Template
This is a first "release". There are a few more issues to be addressed before we call this version 1.0 but this allows us to check the releasing system.
Template/style changes:
References.Rmd
is a new file where all references are printed out. (Note it is added to the _bookdown.yml file).About.Rmd
contains a template credit table that guides you through how to write credits.
Github action changes:
render-preview.yml
This Github action will create a preview branch upon opening a pull request and will update a comment on the PR that will bring you to a preview of what your changes make the Bookdown and Coursera versions of the course will look like. (Note that this does not include any Docker changes)delete-preview.yml
deletes the preview branch created byrender-preview.yml
after the pull request is closed.transfer-rendered-files.yml
will not transfer thedocs/coursera
folder files to the `_Leanpub repository.
Docker image updates:
- Bookdown has been updated 0.20 to 0.24
vim
has been added.