Skip to content

Commit 67b4d8e

Browse files
Add docs for what to document about a new stream (#19696)
Spawning from the follow-up necessary when adding a new stream (#19694)
1 parent 2a82859 commit 67b4d8e

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

changelog.d/19696.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the developer stream docs for creating a new stream to highlight places that require documentation updates.

docs/development/synapse_architecture/streams.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,13 @@ necessary registration and event handling.
179179
- don't forget the super call
180180
- add local-only [invalidations to your writer transactions](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L201)
181181

182+
**Update docs:**
183+
- Update the [*Stream
184+
writers*](https://github.com/element-hq/synapse/blob/develop/docs/workers.md#stream-writers)
185+
section in the worker docs with a new section for the stream
186+
- If this stream can only be handled by specific workers, add a new section to the
187+
[upgrade notes](https://github.com/element-hq/synapse/blob/develop/docs/upgrade.md).
188+
182189
**For streams to be used in sync:**
183190
- add a new field to [`StreamToken`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L1003)
184191
- add a new [`StreamKeyType`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L999)

0 commit comments

Comments
 (0)