1353553 - document antenna architecture [antenna]

Status: RESOLVED FIXED

(Socorro :: Antenna, task)

Description

[Will Kahn-Greene [:willkg] ET needinfo? me]

The Antenna docs have a "spec v1" document which is a rambling stream-of-consciousness account that could easily be mistaken for a Greek tragedy of a poor dog on its way to its favorite bench in the park.

This bug covers writing up an architecture document covering in at least some detail:

1. The purpose of Antenna.

2. What requirements shaped our decisions.

3. How it's structured.

4. The data flow story.

5. Maybe add a recipe for something yummy, too. The Puente docs had that and everyone loved Puente. <http://puente.readthedocs.io/en/latest/granola.html>

Comment 1

[Will Kahn-Greene [:willkg] ET needinfo? me]

In a PR: https://github.com/mozilla/antenna/pull/197

I didn't end up doing a recipe. But might in the future.

Comment 2

[Will Kahn-Greene [:willkg] ET needinfo? me]

I landed these. It's not the best, but it's probably good enough for now. If there are issues, we can improve them.

http://antenna.readthedocs.io/en/latest/architecture.html

One thing I don't want to do is create a ton of documentation that we then have to maintain. I tried to be minimal here, but also maximally useful.

Anyhow, this is done for now. Marking as FIXED.

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

Switching Antenna bugs to Antenna component.