README Update

[lexicondevil]

Note: This is issue is part of the Service Transfer Project. The goal is to ensure project documentation is up to date and help the receiving team understand what the service does and how to maintain and operate it. The previous team is primarily responsible for doing this work, and the receiving team is the stakeholder on this issue and has final approval.

These are a set of guidelines, not a rigid set of requirements. If the receiving team already has expertise on this service and is comfortable operating it, they may complete whatever subset of the tasks they find appropriate and close this issue.

The assignees on this issue are intended to be "manager of previous team" and "manager of new team" based on what's in the Service Ownership Spreadsheet. If these are incorrect please update the assignees on this issue and update the spreadsheet to match.

README Update

A service README should quickly orient someone to the service, what it does, and how it fits into the architecture. An unfamiliar user should be able to look at the README and learn:

• What does the service do? What capabilities does it provide?
• What services does it depend on? What services depend on it?
• What’s the datastore?
• What are its inputs and outputs?
• High-level architecture diagram
• Links to service dashboards
• Link to runbook

That type of information should be at the top of every service readme. Installation and local dev instructions can follow.

Please ensure the service's README meets these criteria, then share it with the receiving team for review.

Examples:
Functions Origin README

[rybit]

This is an public repo. I'm going to close this for now.