Goal:

The goal of this is to add more documentation about the architecture of, and different workflows within, content sources. The audience for this documentation is mainly developers contributing to the project.

Acceptance Criteria:

The documentation added should include the following topics:

• Specific flows,  detailing what each does in each backend service.  Reference other projects (IB, Pulp, candlepin, etc..), use cases
    Introspection
    Snapshotting
    Content Template
• Document tasking system
    * Strategy around idempotentency 
• Explain Notifications
• Testing RBAC
• Update code layout table & fix formatting
• Document metrics & alerting
• Glossary of key terms
    * What is a "public" repo, what is popular repo
• Provides content capabilities similar to:  Satellite, Katello, Spacewalk
• Frontends:
    List of technologies
• IQE core: Explain different environments, where do they live, how do firewalls come into play

Open Questions

• Is there any other documentation that should be added to the frontend?
• Is there any other documentation to add about IQE?
• Where should the IQE documentation live?
• Where should the documentation about our alerts and how to add alerts live?