gfe-db Documentation

[chrisammon3000]

gfe-db Documentation

gfe-db is a work in progress and some help is needed putting together comprehensive documentation. The goal of the documentation should be to help developers understand how it works so it can be maintained and improved.

The official docs here available here:
https://gfe-db.readthedocs.io/en/latest/index.html

Please include your ideas and suggestions for improvements here!

Methodology

The documentation is structured according to the framework described here:
https://ubuntu.com/blog/diataxis-a-new-foundation-for-canonical-documentation

It includes the 4 basic categories of information:

• How-to (Usage)
• Reference
• Explanations (Introduction)
• Tutorials (optional for gfe-db?)

Roadmap of Topics

• Introduction
  • GFE overview
  • How the data pipeline works
    • scheduled data ingestion
    • build process
    • load process
• Usage (how-to)
  • Deploy to AWS
    • Credentials Setup
    • Environment Setup
    • Makefile Usage
  • Loading releases
  • Develop Locally
• Reference
  • Architecture
    • Base infrastructure/VPC
    • Database
    • Pipeline
      • Service APIs
        • Ingest
        • Build
        • Load
  • GFE Graph
  • Service Configurations
  • Makefile reference
• Tutorials (add later)