Skip to content

Commit

Permalink
Add changelog and upgrade in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xcompass committed Aug 17, 2017
1 parent bc8fa70 commit 381baa6
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# v1.0

## Notable changes

* A new location for comparisons, so instructors can view these on the assignment screen alongside answers, help comments, and participation (note: this means existing instructors will notice the absence of the green "See Comparisons" button on the course screen and can access comparisons instead by clicking on the hyperlinked number of comparisons below any assignment)
* Customizable weights for instructors using multiple criteria on an assignment
* The ability for instructors to duplicate assignments
* The option for instructors to customize the instructional text that appears to students prompting the peer feedback portion of the comparison
* Basic notification emails that, when enabled, let instructors know about new help comments and let students know about new replies to their answer
* Automatic embedding of certain multimedia URLS, so links from trusted sources appear in answers without having to be clicked (e.g., YouTube videos)
* Updates to the LTI integration, so ComPAIR can be used at UBC with Canvas
* A new downloadable report for instructors containing student feedback per assignment
* A logo and favicon (bookmark image) for the application
* Improvements to the ComPAIR support site, including the addition of a style guide to keep the application consistent as we grow

For full list of changes: https://github.com/ubc/compair/issues?utf8=%E2%9C%93&q=milestone%3A%22Version%201.0%22%20
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ ComPAIR is accessible at

docker build -t ubcctlt/compair-app .

### Upgrade

docker-compose down
docker pull ubcctlt/compair-app # download latest ComPAIR image
docker-compose up
docker exec -it compair_app_1 alembic upgrade head # upgrade database


Generate Production Release
---------------------------
Run `gulp prod` to generate the production version. This currently just does two things:
Expand Down

0 comments on commit 381baa6

Please sign in to comment.