Merge pull request #20339 from edx/bom/experiments_readme

Initial README for the experiments app

lms/djangoapps/experiments/README.rst

@@ -0,0 +1,16 @@
+Status: Maintenance
+
+Responsibilities
+================
+The Experiments django app provides a generic API and schema-less data model for storing data related to experiments. It contains both user-specific and user-agnostic key-value stores that can be associated with experiments. The mapping between an experiment and its experiment_id is maintained externally to the code, as it is specific to the Open edX instance.
+
+WARNING: Do NOT use this app for storing long-term data. The data in this app is intended to be transitional and deleted once experiments are completed.
+
+Direction: Keep
+===============
+
+Glossary
+========
+
+More Documentation
+==================

lms/djangoapps/experiments/__init__.py

@@ -1,6 +0,0 @@
-"""
-This app is used by the Rapid Experiments Team to hold data related to experiments.
-
-WARNING: Do NOT use this app for anything long-term (or even short-tem) unless you are a member of the team. This app
-is subject to change at any time without notice to those outside of the Rapid Experiments Team.
-"""

lms/djangoapps/experiments/models.py

@@ -5,6 +5,8 @@ from model_utils.models import TimeStampedModel
 
 class ExperimentData(TimeStampedModel):
     """
+    ExperimentData stores user-specific key-values associated with experiments
+    identified by experiment_id.
     .. no_pii:
     """
     user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
@@ -27,6 +29,8 @@ class ExperimentData(TimeStampedModel):
 
 class ExperimentKeyValue(TimeStampedModel):
     """
+    ExperimentData stores any generic key-value associated with experiments
+    identified by experiment_id.
     .. no_pii:
     """
     experiment_id = models.PositiveSmallIntegerField(