1315267 - document antenna

Status: RESOLVED FIXED

(Socorro :: Antenna, task)

Description

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

Antenna has a half-good README, but the docs/ are all out of date or wrong or missing stuff or all of the above.

This bug covers finishing up the documentation for Antenna so that it's usable and maintainable.

Comment 1

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

Probably needs something like:

1. how to set it up and configure it
2. autodoc for major components
3. common troubleshooting?
4. tips for development?

Comment 2

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

This PR covered a lot of docs work:

https://github.com/mozilla/antenna/pull/126

The only thing missing is "common troubleshooting". However, there hasn't been any troubleshooting, yet, so I'm not sure what we'd put here at the moment.

Given that, I'm going to mark this FIXED. If there are things we want to add later, we can do so under different bugs.

Comment 3

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

Switching Antenna bugs to Antenna component.