Skip to content

Commit

Permalink
Formatting glossary (#501)
Browse files Browse the repository at this point in the history
  • Loading branch information
Elise Richards authored Sep 6, 2023
1 parent cff1296 commit bfd0168
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 15 deletions.
3 changes: 3 additions & 0 deletions docs/faq/general/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
label: "General FAQ"
collapsible: true
collapsed: true
13 changes: 13 additions & 0 deletions docs/faq/general/general-faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: general-faq
title: General faq
slug: /general-faq
---

### Question

What's the difference between "Experimenter" and "Nimbus"?

### Answer

Nimbus is the whole experimentation system (handles enrolling/unenrolling users, sending branch configurations, etc). Nimbus was the code name of the experimentation project. If you hear Jetstream, that is the whole analysis system (interfaces with data, runs analysis, formats results). Experimenter is the customer interface to both Nimbus and Jetstream - that you access at experimenter.services.mozilla.com/. In Experimenter users can configure experiments, manage them (launch, monitor, end), and can see the results.
93 changes: 78 additions & 15 deletions docs/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,86 @@ title: Glossary
slug: /glossary
---

* **Behavioral targeting**: [here](/mobile-behavioral-targeting)
* **Bucketing**: [here](/bucketing)
* **Cirrus**: The codename of Nimbus for Web applications. [PRD](https://docs.google.com/document/d/1bg7GUoGeGusiSHE945P0XWkX_beGDQCb7gTMImliI44/edit#heading=h.hs9kv3uaq67s) and [ADR](https://docs.google.com/document/d/1ub46GXVz0rD6vsdS85UF_LvUfJItMwE9jicFCXc1jvw/edit)
* **Co-enrolling**: [here](/fml/coenrolling-features)
* **Custom targeting**: coming soon
## A

----

## B

**Behavioral targeting**: [here](/mobile-behavioral-targeting)

**Bucketing**: [here](/bucketing)

----

## C

**Cirrus**: The codename of Nimbus for Web applications. [PRD](https://docs.google.com/document/d/1bg7GUoGeGusiSHE945P0XWkX_beGDQCb7gTMImliI44/edit#heading=h.hs9kv3uaq67s) and [ADR](https://docs.google.com/document/d/1ub46GXVz0rD6vsdS85UF_LvUfJItMwE9jicFCXc1jvw/edit)

**Co-enrolling**: [here](/fml/coenrolling-features)

**Custom targeting**: coming soon
* [Targeting attributes](https://firefox-source-docs.mozilla.org/browser/components/newtab/content-src/asrouter/docs/targeting-attributes.html)
* [Mobile messaging behavioral targeting](/mobile-behavioral-targeting)
* See also: "Targeting Considerations" on the Nimbus Experiment Brief template available [here](/for-product#where-do-i-start)
* **Experimenter**: This refers to the frontend website (experimenter.services.mozilla.com/) specifically, whereas 'Nimbus' refers to the experimentation system as a whole (the SDK, FML, and web frontend).
* **First-run experiment**: [here](/mobile-first-run-experiments)
* **Feature Manifest Language (FML)**: [here](/fml-spec)
* **Jetstream**: see more [here](/jetstream/jetstream)
* **Kinto**: [docs](https://docs.kinto-storage.org/en/stable/index.html)
* **Remote Settings**:

----

## E

**Experimenter**:
<ul>
Nimbus is the whole experimentation system (handles enrolling/unenrolling users, sending branch configurations, etc). Nimbus was the code name of the experimentation project.
</ul>
<ul>
Experimenter is the customer interface to both Nimbus and Jetstream - that you access at <a href="https://experimenter.services.mozilla.com/">experimenter.services.mozilla.com/</a>. In Experimenter users can configure experiments, manage them (launch, monitor, end), and can see the results.
</ul>

----

## F

**First-run experiment**: [here](/mobile-first-run-experiments)

**Feature Manifest Language (FML)**: [here](/fml-spec)

----

## J

**Jetstream**:
<ul>
Jetstream is the whole analysis system (interfaces with data, runs analysis, formats results). See more <a href="/jetstream/jetstream">here</a>
</ul>

----

## K

**Kinto**: [docs](https://docs.kinto-storage.org/en/stable/index.html)

----

## R

**Remote Settings**:
* [Docs](https://remote-settings.readthedocs.io/en/latest/)
* [Integration with Experimenter](https://github.com/mozilla/experimenter/tree/main/docs/experimenter#overview)
* **Rollout**: A single-branch experiment, often the "winning branch" from an experiment, that can be used to "roll out" a feature to your Audience. See the [Rollouts deep dive](/deep-dives/experimenter/rollouts) for more info.
* **Smoke Test** is a preliminary trial/experiment with minimal setup/limited parameters/minimal user population to ensure that the experiment is operational and that there are no obvious issues. The objective is to catch any major problems early on, allowing us to address them before conducting more in-depth/resource-intensive (stat.sig) experiments. This is common when there are new pieces (like many newly added telemetry probes or complex targeting or triggers) coming together. It is better to learn in a small (hundreds instead of hundreds of thousands people) experiment that your message is triggering at the wrong time to the wrong users, or that your telemetry isn't capturing something you need to learn.
* **What's the difference between Experimenter and Nimbus** Nimbus is the whole experimentation system (handles enrolling/unenrolling users, sending branch configurations, etc). Nimbus was the code name of the experimentation project. If you hear Jetstream, that is the whole analysis system (interfaces with data, runs analysis, formats results). Experimenter is the customer interface to both Nimbus and Jetstream - that you access at experimenter.services.mozilla.com/. In Experimenter users can configure experiments, manage them (launch, monitor, end), and can see the results.
* _More coming soon..._

**Rollout**:
<ul>
A single-branch experiment, often the "winning branch" from an experiment, that can be used to "roll out" a feature to your Audience. See the <a href="/deep-dives/experimenter/rollouts">Rollouts deep dive</a> for more info.
</ul>

----

## S

**Smoke Test**:
<ul>
A smoke test is a preliminary trial/experiment with minimal setup/limited parameters/minimal user population to ensure that the experiment is operational and that there are no obvious issues. The objective is to catch any major problems early on, allowing us to address them before conducting more in-depth/resource-intensive (stat.sig) experiments. This is common when there are new pieces (like many newly added telemetry probes or complex targeting or triggers) coming together. It is better to learn in a small (hundreds instead of hundreds of thousands people) experiment that your message is triggering at the wrong time to the wrong users, or that your telemetry isn't capturing something you need to learn.
</ul>

----

_More coming soon..._

0 comments on commit bfd0168

Please sign in to comment.