Skip to content

Commit

Permalink
docs: Migration guide for 2.0 (#368)
Browse files Browse the repository at this point in the history 
* Squashed commit of the following:

commit 09167ae
Author: JeremyRudman <38338616+JeremyRudman@users.noreply.github.com>
Date:   Sun Sep 20 04:23:15 2020 -0400

    fix(questionnaire): added phone number requirements (#283)

    * fix(questionnaire): added phone number requirement

    using a regex to require users to input a valid phone number and
    stripped non numbers from the stored value with the exception of the
    country code

    * fix(questionnaire): edited callback to pass test

    edit call back that removes non-numbers from phone number to pass
    testing

    * fix(questionnaire): edited test to fail with phone formatting

    edited test to fail if the phone # formating is still there when saved
    into the database. Also stopped exception for "+" as it was not
    necessary.

    * fix(questionnaire): fixed comment about phone number stripping

    * fix: houndci formatting comments

    * fix: earlier fix was incorrect. correct houndci fix

    * fix(phone): implmented changed phone number regex for validation

    implement suggested regex although made internation extention 3 instead
    of 2 digits long for max length

    * fix(questionnaire): added support for more international numbers

    made the numbers regex more flexable to support more international
    numbers such as in Nigeria with two digit area codes.

    * Phone validation hit, remove duplicate check

    Co-authored-by: Chris Baudouin, Jr <cjb5326@rit.edu>
    Co-authored-by: Peter Kos <pkos91@icloud.com>

commit c9d6658
Author: JeremyRudman <38338616+JeremyRudman@users.noreply.github.com>
Date:   Sun Sep 20 04:09:39 2020 -0400

    fix: School text-box dropdown in manage/questionnaires/edit missing background  (#296)

    * fix(questionnaire): fixed background in school autocomplete

    fixed the questionnaire edit page so that it was blank in the management
    edit page

    * fix(questionnaire): sperated autocomplete sass into its own file

    seperated the sass for the autocomplete into its own file so that manage
    could use it without the other sass in forms.sass

    * Use grays for manage backgrouind

    Co-authored-by: Chris Baudouin, Jr <cjb5326@rit.edu>
    Co-authored-by: Peter Kos <pkos91@icloud.com>

commit 113cd61
Author: Chris Baudouin, Jr <cjb5326@rit.edu>
Date:   Sun Sep 20 03:55:37 2020 -0400

    fix: Fixes failing test cases from #242 (#364)

commit 58b5849
Author: Peter Kos <pkos91@icloud.com>
Date:   Sun Sep 20 03:01:47 2020 -0400

    refactor: Renames user roles, improves security

    commit 1daa943
    Author: Peter Kos <pkos91@icloud.com>
    Date:   Sun Sep 20 02:57:01 2020 -0400

        Organizers have same overview page access as direc

    commit cdf57b6
    Author: Peter Kos <pkos91@icloud.com>
    Date:   Sun Sep 20 02:56:41 2020 -0400

        Volunteers are redirected to checkin route

    commit 3f2a30c
    Merge: b5ad3b8 d87269d
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sun Sep 20 00:30:03 2020 -0400

        Merge branch '2.0' into hm-242

    commit b5ad3b8
    Author: Jeremy Rudman <jeremyrudman@gmail.com>
    Date:   Sat Sep 19 21:03:08 2020 -0400

        fix(sidebar): fixed UI problems for diffrent roles

        removed the duplicate checkin button for orginizers and had checkin page defaut to be highlighted for volenteers

    commit 057e3aa
    Merge: 971dd0a 69e8d6e
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Mon Sep 14 16:43:59 2020 -0400

        Merge branch '2.0' into hm-242

    commit 971dd0a
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Mon Sep 14 16:37:18 2020 -0400

        refactor: Increases funciton clarity

    commit 711aeea
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Mon Sep 14 16:35:56 2020 -0400

        refactor: Increases funciton clarity

    commit 19f1926
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sat Sep 12 00:46:52 2020 -0400

        fix: Hound issues v1

    commit c3d44f0
    Merge: 2ab8865 a767446
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sat Sep 12 00:32:30 2020 -0400

        Merge branch '2.0' into hm-242

    commit 2ab8865
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sat Sep 12 00:29:43 2020 -0400

        refactor: Cleans tests, improves coverage

    commit 59d54ed
    Merge: 274787f cb16869
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Mon Sep 7 00:11:19 2020 -0400

        Merge branch '2.0' into hm-242

    commit 274787f
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sun Sep 6 23:59:27 2020 -0400

        refactor: Renames event_tracking to Volunteer

    commit 873e43c
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sun Sep 6 23:48:29 2020 -0400

        refactor: Renames admin_limited_access to Organizer

    commit f592750
    Author: Chris Baudouin, Jr <cjb5326@rit.edu>
    Date:   Sun Sep 6 19:38:54 2020 -0400

        refactor: Changes admin to director

commit 0237965
Author: Peter Kos <pkos91@icloud.com>
Date:   Sun Sep 20 02:27:55 2020 -0400

    fix: Text centering on application page  (#361)

    * Fix bug

    * Long containers are left aligned,not centernewline

commit 28913f7
Author: JeremyRudman <38338616+JeremyRudman@users.noreply.github.com>
Date:   Sun Sep 20 02:16:29 2020 -0400

    fix(bus_captain): Alerts admins if a bus captain is removed (#270)

    * fix(bus_captain): alerts admins if a bus captain is removed

    if a bus captain changes bus or declinces a rsvp he is removed as a bus
    captain. All admins are alerted to the removal of a bus captain by email

    * fix: corrected houndci formating errors

    * Refactor var names; remove auto captain interest

    * On questnnre destroy, email admins if bus captain

    * Don’t send email remove_captain on first bus assignment

    * Tests!

    * bark bark

    Co-authored-by: Chris Baudouin, Jr <cjb5326@rit.edu>
    Co-authored-by: Peter Kos <pkos91@icloud.com>

commit d87269d
Author: David Quach <dq6180@rit.edu>
Date:   Sun Sep 20 00:13:52 2020 -0400

    feat: Automatically remind people to RSVP (#175)

    * feat: add rsvp reminder email to trigger and automation process based on loose rules

    * feat: add the rsvp reminder email to queue_reminder_email class

    * fix: fix issue with hound

    * fix: resolve issues with linting and fix conditionals

    * fix: more linting issues

    * fix: more more linting issues

    * seperate the two functions

    * update on per Stuart instruction, make this more automated

    * forgot to commit this

    * remove this unnecessary piece of code

    * fix linting issues

    * remove since we are not using this

    * Update app/models/user.rb

    Co-Authored-By: Stuart Olivera <stuart@stuartolivera.com>

    * forgot to add end

    * resolve for hound

    * fix(dashboard): Fixes security vulnerability that allowed event_tracking role to access Dashboard (#215)

    * chore(release): 1.22.3 [skip ci]

    ## [1.22.3](v1.22.2...v1.22.3) (2020-05-16)

    ### Bug Fixes

    * **dashboard:** Fixes security vulnerability that allowed event_tracking role to access Dashboard ([#215](#215)) ([](74a40ad))

    ### Styles

    * **check-in:** Changes table header to be more descriptive ([#207](#207)) ([](889fbd0))
    * **config:** Removes unused event_is_over flag ([#208](#208)) ([](0c73e66))

    * build(deps): Upgrade yarn (#212)

    * build(deps): Upgrade yarn

    * build(deps): Upgrade gems

    * build(deps): Remove obsolete gems

    * v0.0.0

    * build(deps): Update semantic-release

    * fix(questionnaire): visual bug in school autocomplete school dropdown

    the css was set for an "a" tag when the list was made up of divs so I
    switched the css to work for the "div" tag in the autocomplete

    * fix(questionnaire): visual bug in school autocomplete school dropdown

    the css was set for an "a" tag when the list was made up of divs so I
    switched the css to work for the "div" tag in the autocomplete. I also
    hide a element that was not present earlier

    * build(deps): Upgrades Rails to 5.2.4.3

    * build(deps): Upgrades gems

    Co-authored-by: Jeremy Rudman <jeremyrudman@gmail.com>

    * fix: Fixes date issue with RSVP reminder job

    * fix: Fixes bug where message would not send

    * refactor: Change subject of RSVP reminder

    * refactor: Verbage changes, updated reminder message

    * 2.0: Removes SparkPost mentions for 2.0

    * fix: Fixes timezone issues

    * fix: More timezone issues

    Co-authored-by: Stuart Olivera <stuart@stuartolivera.com>
    Co-authored-by: Chris Baudouin, Jr <cjb5326@rit.edu>
    Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
    Co-authored-by: Jeremy Rudman <jeremyrudman@gmail.com>
    Co-authored-by: Chris Baudouin, Jr <chrisbaudouinjr@icloud.com>

commit 2e9379f
Author: Peter Kos <pkos91@icloud.com>
Date:   Sat Sep 19 22:31:18 2020 -0400

    fix: Hackathon names now consistently on newline, wrapping is centered (#358)

    * Hackthon name title page has newline

    * Make houndbot happy

* Add 2.0 migration docs, rename maintenance file

* Spacing fixes

* 2.0 migration guide -> whats new in 2.0

* Add entry for reminder email + explanation

Co-authored-by: Chris Baudouin, Jr <cjb5326@rit.edu>
  • Loading branch information
@peterkos @cbaudouinjr
peterkos and cbaudouinjr authored Sep 21, 2020
1 parent 434cfb3 commit 3745d9c
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 1 deletion.
82 changes: 82 additions & 0 deletions docs/2.0-whats-new.md
View file
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)`
0 docs/maintenance.md → docs/updating-hm.md
View file
File renamed without changes.
3 changes: 2 additions & 1 deletion website/sidebars.json
View file
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

0 comments on commit 3745d9c

Please sign in to comment.