Skip to content

Commit e15db3b

Browse files
authored
Merge pull request #101 from reddit/update_docs_w_version_and_zk
Update docs
2 parents 81a602d + 991e476 commit e15db3b

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

docs/index.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,13 @@ Prerequisite infrastructure
2020
---------------------------
2121
**Zookeeper live-data sidecar**:
2222

23-
Set up your service to pull down & synchronize experiment configurations from Zookeeper via the Baseplate `live-data watcher sidecar
24-
<https://baseplate.readthedocs.io/en/stable/api/baseplate/lib/live_data.html?highlight=sidecar#watcher-daemon>`_ (minimum v2.5.4).
25-
You'll have to make sure that your service is authorized to fetch the appropriate secret from Vault.
26-
See example setup `here
27-
<https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Live-Data-Sidecar>`__.
23+
Define a **live-data sidecar** in the manifest file to fetch the experiment configuration, see example setup `here
24+
<https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Live-Data-Sidecar>`__
25+
(make sure that your service is authorized to fetch the appropriate secret from Vault).
2826

2927
**Event publisher sidecar**:
3028

31-
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>`_
32-
. See example setup `here <https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Event-Publisher-Sidecar>`__.
29+
Set up your service to be able to publish v2 exposure events via an **event publisher sidecar**, see example setup `here <https://reddit.atlassian.net/wiki/spaces/EX/pages/343212125/Running+Experiments+at+Reddit#Event-Publisher-Sidecar>`__.
3330

3431
Prerequisite configuration
3532
---------------------------
@@ -65,7 +62,7 @@ Upgrade or integrate reddit-experiments package:
6562
.. code-block:: python
6663
6764
# import latest reddit-experiments package in service requirements.txt
68-
reddit-experiments>=1.3.14
65+
reddit-experiments>=1.4.0
6966
7067
Initialize :code:`decider` instance on Baseplate context
7168
--------------------------------------------------------

reddit_decider/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,8 @@ def get_variant_for_identifier(
425425
) -> Optional[str]:
426426
"""Return a bucketing variant, if any, with auto-exposure for a given :code:`identifier`.
427427
428-
Note: If the experiment's :code:`bucket_val` (e.g. "user_id", "device_id", "canonical_url")
428+
Note: If the experiment's :code:`bucket_val`
429+
(e.g. "user_id", "device_id", "canonical_url", "subreddit_id", "ad_account_id", "business_id")
429430
does not match the :code:`identifier_type` param,
430431
the :code:`identifier` will be ignored and not used to bucket (:code:`{identifier_type: identifier}` is
431432
added to internal :code:`DeciderContext` instance, but doesn't act like a bucketing override).
@@ -486,7 +487,8 @@ def get_variant_for_identifier_without_expose(
486487
) -> Optional[str]:
487488
"""Return a bucketing variant, if any, without emitting exposure event for a given :code:`identifier`.
488489
489-
Note: If the experiment's :code:`bucket_val` (e.g. "user_id", "device_id", "canonical_url")
490+
Note: If the experiment's :code:`bucket_val`
491+
(e.g. "user_id", "device_id", "canonical_url", "subreddit_id", "ad_account_id", "business_id")
490492
does not match the :code:`identifier_type` param,
491493
the :code:`identifier` will be ignored and not used to bucket (:code:`{identifier_type: identifier}` is
492494
added to internal :code:`DeciderContext` instance, but doesn't act like a bucketing override).

0 commit comments

Comments
 (0)