Skip to content

Commit b6be4f2

Browse files
committed
add event sidecar docs
1 parent a9c9a25 commit b6be4f2

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Add the client to your application's Baseplate context:
1717

1818
```python
1919
from reddit_decider import decider_client_from_config
20-
20+
2121
decider = decider_client_from_config(
2222
app_config=app_config,
2323
event_logger=ExperimentLogger(),
@@ -34,7 +34,8 @@ def my_method(request):
3434
pass
3535
```
3636

37-
See [the documentation] for more information.
37+
See [the documentation] for more information (documentation builds can be found [here](https://readthedocs.org/projects/reddit-experiments/builds/))
38+
.
3839

3940
[the documentation]: https://reddit-experiments.readthedocs.io/
4041

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,18 @@ Prerequisite packages
2121
2222
Prerequisite infrastructure
2323
---------------------------
24+
**Zookeeper live-data sidecar**:
25+
2426
Set up your service to pull down & synchronize experiment configurations from Zookeeper via the Baseplate `live-data watcher sidecar
2527
<https://baseplate.readthedocs.io/en/stable/api/baseplate/lib/live_data.html?highlight=sidecar#watcher-daemon>`_ (minimum v2.5.4).
2628
You'll have to make sure that your service is authorized to fetch the appropriate secret from Vault.
29+
See example setup `here
30+
<https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Live-Data-Sidecar>`__.
31+
32+
**Event publisher sidecar**:
33+
34+
Set up your service to be able to publish v2 exposure events via an `events sidecar <https://baseplate.readthedocs.io/en/stable/api/baseplate/lib/events.html?highlight=sidecar#publishing-events>`_
35+
. See example setup `here <https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Event-Publisher-Sidecar>`__.
2736

2837
Prerequisite configuration
2938
---------------------------

0 commit comments

Comments
 (0)