Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Openverse documentation

Toggle table of contents sidebar

Django API
Toggle navigation of Django API
- Guides
  Toggle navigation of Guides
- Reference
  Toggle navigation of Reference
Automations
Toggle navigation of Automations
- Guides
  Toggle navigation of Guides
  - Quickstart Guide
- Reference
  Toggle navigation of Reference
  - Python Scripts
  - Project Automations
Airflow Catalog
Toggle navigation of Airflow Catalog
- Guides
  Toggle navigation of Guides
- Reference
  Toggle navigation of Reference
  - DAGs
  - Retired
Changelogs
Toggle navigation of Changelogs
Nuxt frontend
Toggle navigation of Nuxt frontend
- Guides
  Toggle navigation of Guides
- Reference
  Toggle navigation of Reference
General development guidelines
Toggle navigation of General development guidelines
- Get started with contributions
  Toggle navigation of Get started with contributions
- General setup guide
- Quickstart guide
- Run
- Test
- Zero Downtime and Database Management
- Deployments
- Logging
- Testing HTTPS
- Stack
Ingestion server
Toggle navigation of Ingestion server
- Guides
  Toggle navigation of Guides
- Reference
  Toggle navigation of Reference
Managing the Openverse
Toggle navigation of Managing the Openverse
- Brand assets
- Responding to Incidents
  Toggle navigation of Responding to Incidents
  - Runbooks
    Toggle navigation of Runbooks
    - Incident Response Runbook
- Project boards
  Toggle navigation of Project boards
- CI + CD workflow
  Toggle navigation of CI + CD workflow
  - Actions
  - Jobs
    Toggle navigation of Jobs
  - Flow
  - Proof-of-functionality
  - Artifacts
- Openverse Decision-Making Process
  Toggle navigation of Openverse Decision-Making Process
- Documentation
  Toggle navigation of Documentation
- Monitoring the Openverse
  Toggle navigation of Monitoring the Openverse
- Openverse Infrastructure Maintenance
  Toggle navigation of Openverse Infrastructure Maintenance
  - Elasticsearch cluster maintenance
- Media properties
  Toggle navigation of Media properties
Subpackages
Toggle navigation of Subpackages
- @openverse/eslint-plugin
  Toggle navigation of @openverse/eslint-plugin
  - analytics-configuration
  - no-unexplained-disabled-test
- openverse-attribution
Projects
Toggle navigation of Projects
- Project Planning
- Template: Implementation Plan
- Template: Project Directory index.md
- Template: Project Proposal
- Yearly Planning
  Toggle navigation of Yearly Planning
  - Yearly Planning: Process Outline
  - Project Themes
- 3D Model Support
  Toggle navigation of 3D Model Support
  - 2022-02-21 Project Proposal: 3D model support
- Additional Search Views
  Toggle navigation of Additional Search Views
- Analytics
  Toggle navigation of Analytics
  - 2022-10-06 Implementation Plan: Frontend event tracking
  - 2023-03-07 Implementation Plan: Analytics backend and visualisation service
- Core User Interface Improvements
  Toggle navigation of Core User Interface Improvements
  - 2023-03-14 Project Proposal: Core UI Improvement
- Dark Mode
  Toggle navigation of Dark Mode
  - 2024-03-13 Project Proposal
  - 2024-03-25 Implementation Plan: Dark Mode
- Data Normalization
  Toggle navigation of Data Normalization
  - 2024-02-27 Implementation Plan: Catalog Data Cleaning
- Document all media properties
  Toggle navigation of Document all media properties
- Samples
  Toggle navigation of Samples
- Feature Flags
  Toggle navigation of Feature Flags
  - 2022-03-09 Project Proposal: Feature flags
- Frontend UI State Cookie
  Toggle navigation of Frontend UI State Cookie
  - 2022-02-18 Project Propsal: Frontend UI State Cookie
- Openverse Infrastructure
  Toggle navigation of Openverse Infrastructure
  - 2024-01-05 Implementation Plan: Finish moving all services to openverse.org
- Ingestion server removal
  Toggle navigation of Ingestion server removal
  - 2024-03-19 Project Proposal: Removal of the Ingestion Server
  - 2024-03-28 Implementation Plan: Ingestion Server Removal
- Monitoring
  Toggle navigation of Monitoring
  - 2022-03-07 Project Proposal: Monitoring
  - 2023-06-06 Implementation Plan: Baseline Alarms for ECS Services
    Toggle navigation of 2023-06-06 Implementation Plan: Baseline Alarms for ECS Services
    - Stable Run Book Sample
    - Unstable Run Book Sample
- Monorepo
  Toggle navigation of Monorepo
  - 2022-11-24 Project Proposal: Monorepo
- Nuxt 3 Migration
  Toggle navigation of Nuxt 3 Migration
  - 2023-06-02 Project Proposal
- Popularity Calculation Optimizations
  Toggle navigation of Popularity Calculation Optimizations
  - 2023-04-06 Project Proposal: Popularity Calculation Optimizations
  - Implementation Plan: Decoupling Popularity Calculations from the Data Refresh
- Project board improvements
  Toggle navigation of Project board improvements
  - 2023-09-13 Project proposal: Project board improvements
  - 2023-09-14 Implementation plan: Project automations
- Providing and maintaining an Openverse image dataset
  Toggle navigation of Providing and maintaining an Openverse image dataset
  - 2023-07-06 Project Proposal: Providing and maintaining an Openverse image dataset
- Python packaging and code sharing
  Toggle navigation of Python packaging and code sharing
  - 2024-04-12 Implementation Plan: Switching to a new Python package manager
- Rekognition Data Incorporation
  Toggle navigation of Rekognition Data Incorporation
  - 2024-03-20 Project Proposal: Incorporate Rekognition data into the Catalog
  - 2024-04-23 Implementation Plan: Machine-generated tags in the API
- Search Relevancy Sandbox
  Toggle navigation of Search Relevancy Sandbox
- Sensitive Content Report Moderation Initial Practices
  Toggle navigation of Sensitive Content Report Moderation Initial Practices
- Detecting and Blurring Sensitive Textual Content
  Toggle navigation of Detecting and Blurring Sensitive Textual Content
- Trust and Safety
  Toggle navigation of Trust and Safety
  - 2023-01-09 Initial Overview and User Stories
  - Sensitive Content Report Moderation Initial Practices
    Toggle navigation of Sensitive Content Report Moderation Initial Practices
  - Detecting and Blurring Sensitive Textual Content
    Toggle navigation of Detecting and Blurring Sensitive Textual Content
- Visual Regression Testing
  Toggle navigation of Visual Regression Testing
  - 2022-02-17 Implementation Plan: Visual regression testing
- Pinia Conversion
  Toggle navigation of Pinia Conversion
  - 2022-02-23 Project Proposal: Vuex to Pinia conversion

Openverse Terms of Service

External links

Openverse
GitHub

Toggle table of contents sidebar

Guides¶

Quickstart guide
Testing guide
Deployment runbook
API Documentation Guidelines
Local HTTPS testing

Quickstart guide

Made with Sphinx and @pradyunsg's Furo