Skip to content

Add documentation about ingestion server #1250

Open

Description

Problem

The ingestion server is almost entirely undocumented, but is a relatively complex piece of code that is critical to Openverse's ongoing operation.

Description

Augment existing documentation about how to run the ingestion server locally with information about how the ingestion server works, what the different actions do, and how the tests run locally (document the integration-docker-compose stuff).

Alternatives

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    ✨ goal: improvementImprovement to an existing user-facing feature📄 aspect: textConcerns the textual material in the repository🔒 staff onlyRestricted to staff members🟩 priority: lowLow priority and doesn't need to be rushed🧱 stack: documentationRelated to Sphinx documentation

    Type

    No type

    Projects

    • Status

      📋 Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions