Welcome to Open edX Filters’s Documentation!

Open edX Filters is a type of hook in the Hooks Extension Framework that allows extending the Open edX platform in a more stable and maintainable way. If you’re new to this approach for extending Open edX, start by reading the docs.openedx.org:Hooks Extension Framework documentation. This documentation provides an overview of the framework’s concepts and structure to support your adoption of Open edX Filters.

Contents:

• Concepts
  • Open edX Filters
• References
  • Open edX Filters Tooling
  • Open edX Filters Glossary
  • Filters
  • Filter Configurations
  • Django Plugins and Filters
  • Real-Life Use Cases for Open edX Filters
  • Architecture Subdomains
  • Documenting Open edX Filters Classes
  • Naming Suggestions for Open edX Filters
• How-tos
  • Create a New Open edX Filter with Long-Term Support
  • Create a Pipeline Step
• Quickstarts
  • Using Open edX Filters in the LMS service
• Decisions
  • 1. Purpose of this Repo
  • 2. Configuration for filters in the Hooks Extension Framework
  • 3. Filter tooling: pipeline behaviour
  • 4. Open edX filters naming and versioning
  • 5. Open edX filters payload conventions
  • 6. Filter tooling: debugging tools
  • 7. Filters Design Practices