Opened on 06/12/2015 at 12:05:29 PM

Last modified on 09/17/2019 at 03:17:39 PM

#2676 new change

Document notification.json and the notifications repository

Reported by: fhd Assignee:
Priority: P3 Milestone:
Module: Sitescripts Keywords:
Cc: wspee Blocked By:
Blocking: Platform: Unknown
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

Description

Background

We don't have any documentation for the notification system, which consists of two parts:

  1. The notification.json file returned by notification servers and parsed by the clients.
  2. The ​notifications repository used to generate notification.json.

What to change

Document both the format of notification.json and the format of the _notifications_ repository in sitescripts/notifications/README.md.

Attachments (0)

Change History (4)

comment:1 Changed on 06/12/2015 at 12:07:51 PM by fhd

#2162 has some examples for how the group mechanism works, the unit tests in Core have many notification.json examples.

comment:2 Changed on 03/06/2018 at 02:28:42 PM by kvas

  • Cc wspee added
  • Tester set to Unknown

@wspee: Do you think ​this doc is sufficient to consider this ticket done? If not, shall we collaborate on producing the remaining part?

comment:3 Changed on 09/17/2019 at 10:52:56 AM by kvas

Hi @wspee, I'm cleaning up old tickets in Trac and I came across this one.

The linked doc from my last comment seems sufficient and it's also linked from the ​README. What if we just move it to the sitescripts repo (for more permanence) and close this ticket?

comment:4 Changed on 09/17/2019 at 03:17:39 PM by wspee

@kvas Works for me :)

Add Comment

Modify Ticket

Change Properties
Action
as new .
as The resolution will be set. Next status will be 'closed'.
to The owner will be changed from (none).
Next status will be 'reviewing'.
Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.