Skip to content

Commit

Permalink
Add admin user guide for product update
Browse files Browse the repository at this point in the history
  • Loading branch information
sibinhho99 committed Dec 28, 2023
1 parent c35432a commit 41599d4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Before following the below instructions, please ensure that you have met all the
- [Adding support for new language in SSID](doc/add_support_for_new_language.md)
- [Deploying SSID app on a Linux/Unix production server](doc/deploying_rails_on_linux.md)
- [Guide for semestral clearing of courses and submissions](doc/semestral_clearing_guide.md)
- [Setting product update announcement](doc/set_product_update_message)
- [User Guide](doc/SSID_User%20Guide_V2.pdf)

## Contact
Expand Down
20 changes: 20 additions & 0 deletions doc/set_product_update_message.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Setting product update announcement
=======================

This guide lists the steps required to use SSID's product update announcements. This feature might be used to announce new feature releases or updates for greater feature awareness and discovery.

The product update message appears on the Home tab of SSID after the user logs in as in the following figure:

![Product update announcement](https://user-images.githubusercontent.com/29513997/208039798-c23b8df5-b98e-45e6-a979-8255b3946a6b.png)

The product update message can be set using the rake task
`rake SSID:set_product_update_message[message]`.

You can toggle the visibility of the message using the following rake tasks:
- `rake SSID:set_product_update_visibility['Y']` for making the message visible.
- `rake SSID:set_product_update_visibility['N']` for making the message invisible.

The commands should be appropriately adapted based on your local setup. For instance, you might need to prepend it with `bundle exec` or use escape characters for symbols e.g. `bundle exec rake SSID:set_product_update_message\["Now you can print reports with multiple student pairs\!"\]`).

Refer to this video demo for usage example:
[https://youtu.be/DtyGSvB5m-U](https://youtu.be/DtyGSvB5m-U)

0 comments on commit 41599d4

Please sign in to comment.