---

Content Output Review and Generation Interface (CORGI)

CORGI is a multi-part system that provides different ways to produce OpenStax book artifacts for Content Managers (CMs), QA, and developers. CORGI is used to create, monitor, and display the status of content production tasks.

Table of Contents

• Managing the Swarm
  • CORGI Infrastructure
  • Releasing CORGI
  • Troubleshooting CORGI in Production
• Generate Pipeline Configurations
• Backup and Restore the Database
  • Prerequisites
  • Backup the Database
    • Check Connection to Swarm
    • Find the database container
    • Set the $DB_CONTAINER
    • Create the backup
  • Restore the Database
    • Prepare the environment
    • Copy the backup file onto the container volume
    • Restore the backup
• Summary
  • CORGI Job Dashboard
  • Enki
• Development Internals
  • Installing Docker
• Local development
  • GitHub OAuth Disabled (Leashed Mode)
  • GitHub OAuth Enabled
  • Functions Patched in Leashed Mode
  • Hot Reloading
  • Run backend unit tests
  • Run integration and UI tests
  • How to develop UI tests
  • Clear the database
  • Migrations
  • Load testing for the backend (Under Construction)
• Sphinx Documentation
  • View the Docs
  • Editing The Docs
  • Auto-generated docs
• Releasing
• Deploying Web Hosting Pipeline
• Attribution
• Login with GitHub Personal Access Token (PAT)
  • Example
• Generating an ERD
  • Running the script
  • How it works
  • Limitations (TODO?)
• CORGI ERD

Extras

• Glossary

Indices and Tables

• Module Index

• Index