DPL-427 Events documentation

[KatyTaylor]

Describe the Housekeeping
We should document all the events that we send to the event warehouse in one place, so that people trying to write reports know what's available to them. This would prevent them having to ask PSD what's available. We, as a team, do also not always know what's available, so it would also save us time.

I'm currently aware of several places where subsets of events are documented:

• For TAT reporting (scroll to bottom of page): https://ssg-confluence.internal.sanger.ac.uk/display/PSDPUB/Turn-around-time+%28TAT%29+reporting
• LabWhere events: https://ssg-confluence.internal.sanger.ac.uk/display/PSDPUB/LabWhere+Events
• Heron cherrypicking events (Beckman): https://ssg-confluence.internal.sanger.ac.uk/display/PSDPUB/%5BBeckman%5D+Cherrypicking+Events
• Heron cherrypicking events (Biosero): https://ssg-confluence.internal.sanger.ac.uk/display/PSDPUB/%5BBiosero%5D+Cherrypicking+Events
• Basic instruction page - https://ssg-confluence.internal.sanger.ac.uk/display/PSDPUB/MLWH_Events+101+And+Useful+Queries

These pages should be updated to point to the general events list once it's created, rather than duplicating the information.

The form of the documentation can be decided by whoever picks up the issue. The documentation should be available to everyone within Sanger. I think they should not have to create any new accounts to access it (e.g. GitHub account). Some ideas are:

• A single Confluence page
• A (public) page in GitHub
• Primary source in the database, in fields like 'description' on event_types, role_types and subject_types tables. This would need to also be exported to a more easily readable / accessible place, and have some instructions for updating that export.

Also consider:

• Including some extra detail / history of the events, to help with understanding historical data.
• Including list of known stakeholders to notify about breaking changes to events - include co-track. Could just use the mlwh-notices email address?