Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Migration guide for 2.0 #368

Merged
merged 7 commits into from
Sep 21, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions docs/2.0-whats-new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
id: 2.0-whats-new
title: What's New in v2.0
---

HackathonManager 2.0 has a lot of new features, changes, and bug fixes! This page serves to detail the updates that may affect your existing instance of HackathonManager.


## Updating

If you are not currently on v2.0, see the guide for [updating HM](updating-hm.md).


## New Features

- Dashboard map!
- This is an initial version of this feature, and we have many improvements planned for the next version.
- Dashboard sidebar navigation has been redesigned (now has groups!)
- Directors can view user accounts directly (**Users & Staff** page)
- Directors can block the ability to submit questionnaires
- Password reset screen has been redesigned
- Questionnaires can now be deleted without deleting the associated user
- This is useful if a staff member (volunteer/organizer/director) decides to no longer attend the hackathon.
- Phone number is now validated in questionnaire form
- We are planning to add a more robust implementation down the line, but for now, this prevents obvious errors in phone numbers (i.e., text).

<details>
<summary> Many variations are accepted (click to toggle) </summary>
```
(123) 456-7890
(123)456-7890
123-456-7890
123.456.7890
1234567890
+31636363634
075-63546725
+123(203)1234567
+011234567890
+234-9-461-4000
+234-09-461-4000
```
</details>
- Directors (prev: admins) are now notified when a bus captain leaves their bus list, or they deny their RSVP.
- Users who didn't finish their application are now sent a reminder email:
- 7 days after they were accepted (if signed up >2 weeks before event)
- 5 days before event (if signed up >10 days before event)
- 2 days before event (if signed up >3 days before event)
- When sending a message, HM now prompts with a confirmation message indicating the number of recipients.
- More detailed [API Documentation](api-overview) is now available
- Added [Updating HackathonManager](updating-hm.md) documentation


## Changes

- "Convert to Admin" button removed on Questionnaire pages.
- Instead, go to the corresponding User (in the `Users & Staff` page) and change their role.
- Role updates
- Roles have been **renamed** as follows:
- | Old Role | New Role |
|----------------------|-----------|
| User | User |
| event_tracking | Volunteer |
| admin_limited_access | Organizer |
| Admin | Director |

- Directors can modify the permissions of organizers, while organizers cannot modify other organizers' permissions.
- (Eventually, we plan to add [custom role support](https://github.com/codeRIT/hackathon-manager/issues/243)! Stay tuned.)

- MyMLH has been updated to V3
- Documentation for [environment variables](deployment-environment-variables.md) has been updated
- Documentation for [messages](messages.md) has been updated
- 24hr event reminder wording addresses all attendees in the message, not just MyMLH attendees


## Bug Fixes

- When editing a questionnaire, the school autocomplete dropdown now has a background
- "Please sign in or sign up to continue" message no longer flashes on sign-in page
- Long hackathon names no longer wrap on the account registration page
- Note that we do not support names longer than 31 characters; this limit will be strictly enforced in a future version of HM.
- When creating a questionnaire, the school dropdown now fits to the size of the form field, instead of stretching offscreen
- Trying to view a questionnaire modified by a deleted admin now communicates `(deleted user)`
File renamed without changes.
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"customization"
],
"Maintenance" : [
"updating-hm"
"updating-hm",
"2.0-whats-new"
],
"Docs": ["docs-overview", "questionnaires", "messages", "busses"],
"API": ["api-overview", "api-testing-setup"],
Expand Down