Event design and naming how-to

[robrap]

We should consider adding a how-to for adding events, that may pull from and reference ADRs, but would be a clear how-to document.

One potentially missing detail, is whether all Data objects should have the suffix "Data"? See

openedx-events/openedx_events/learning/data.py

Line 142 in 6e48994

class DiscussionTopicContext:

for one example that doesn't match this convention. Separate and related, do we want linting to help enforce any conventions?

Do we want to document known subdomains? (I have additional questions about this, but better left to a separate issue.)

[mariajgrimaldi]

We should consider adding a how-to for adding events

Yes, I remember doing this for the conference. I'll brush up on what I wrote in a new PR.

One potentially missing detail, is whether all Data objects should have the suffix "Data"?

During the event's design, our primary focus was: event identification & the implemented name of the event, which we added in the naming conventions ADR, so the data classes were created more organically. Now, we should decide if we need to make that naming a convention.

[mariajgrimaldi]

I opened a PR with the how-to draft: #80

[mariajgrimaldi]

I'll close this as completed by #80