Opened 4 years ago

Last modified 2 months ago

#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.

Change History (4)

comment:1 Changed 4 years ago 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 21 months ago 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 2 months ago 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 2 months ago by wspee

@kvas Works for me :)

Note: See TracTickets for help on using tickets.