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

Add reference docs for the EventStream #29109

Closed
patriknw opened this issue May 25, 2020 · 2 comments
Closed

Add reference docs for the EventStream #29109

patriknw opened this issue May 25, 2020 · 2 comments
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Issues that the core team will likely not have time to work on t:docs
Milestone

Comments

@patriknw
Copy link
Member

I don't think we mention it in the reference docs.

It's accessible from ActorSystem.eventStream and API docs: https://doc.akka.io/api/akka/2.6.5/akka/actor/typed/eventstream/EventStream$.html

@patriknw patriknw added 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Issues that the core team will likely not have time to work on t:docs labels May 25, 2020
@muskan3006
Copy link
Contributor

Hey @patriknw can you please guide me a bit about how to do it?
We want to add a .md file for this?

@johanandren
Copy link
Member

We have this for the classic actor system: https://doc.akka.io/docs/akka/current/event-bus.html#classic-event-bus
but nothing for the corresponding EventStream for a typed actor system, so yes, a new doc page about what it is and how to interact with it (subscribe/publish), and then crosslink between the two like other pairs of classic - typed pages for the same concept.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Issues that the core team will likely not have time to work on t:docs
Projects
None yet
Development

No branches or pull requests

3 participants