Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation page about events #152

Merged
merged 4 commits into from
May 11, 2023
Merged

Conversation

callumforrester
Copy link
Contributor

  • Add page about events to developer documentation
  • Explain why we need to add new events on top of the event model
  • Explain the use of correlation IDs

@callumforrester
Copy link
Contributor Author

Still to do: make API reference and point to that

@codecov
Copy link

codecov bot commented Apr 25, 2023

Codecov Report

Merging #152 (58ecb40) into main (e8e1fda) will decrease coverage by 8.61%.
The diff coverage is n/a.

❗ Current head 58ecb40 differs from pull request most recent head 6256cea. Consider uploading reports for the commit 6256cea to get more accurate results

@@            Coverage Diff             @@
##             main     #152      +/-   ##
==========================================
- Coverage   83.07%   74.47%   -8.61%     
==========================================
  Files          40       37       -3     
  Lines        1111     1050      -61     
==========================================
- Hits          923      782     -141     
- Misses        188      268      +80     

see 11 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@callumforrester callumforrester marked this pull request as ready for review May 3, 2023 08:13
Copy link
Contributor

@DiamondJoseph DiamondJoseph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, otherwise LGTM

docs/developer/explanations/events.rst Outdated Show resolved Hide resolved
@DiamondJoseph
Copy link
Contributor

Presumably going to need an update for emitting state events on same topic?

@keithralphs
Copy link
Contributor

Presumably going to need an update for emitting state events on same topic?

Do that as part of addressing #176

@DiamondJoseph DiamondJoseph self-requested a review May 11, 2023 15:25
@callumforrester callumforrester merged commit c4b95d2 into main May 11, 2023
@callumforrester callumforrester deleted the explain-events branch May 11, 2023 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants