“How-To” Guides

• How To Add a Catalog File
  • Assumptions
  • Steps
• Add an XBlock Aside
  • Prerequisites
  • Step 1: Scaffold a Python package
  • Step 2: Define the Aside class
  • Step 3: Declare fields for course-author control
  • Step 4: Decorate the views you want to inject into
  • Step 5: Add a handler to persist the toggle
  • Step 6: Add the JavaScript that wires up the checkbox
  • Step 7: Filter to specific block types
  • Step 8: Register the Aside as an entry point
  • Step 9: Install the package and restart services
  • Step 10: Enable asides in the LMS and Studio
  • Step 11: Verify the Aside is rendering
  • Step 12: Talk to the Learning MFE via postMessage (optional)
  • Next Steps
• How To Add Sphinx Docs to a Repo
  • Assumptions
  • Steps
• How To Enable Javascript Upgrade Automation
  • Assumptions
  • Steps
• How To Enable Python Upgrade Automation
  • Assumptions
  • Steps
• Enabling Translations on a New Repo
  • Quickstart
  • Configuration
    • Python Django Plugins and XBlocks
    • Django Microservice Repos (IDAs)
    • React Repos
  • Testing and Debugging
    • Testing translations sync in your fork
    • Debugging translations workflows
• How To Get Ready for Frontend Development
  • Assumptions
  • Steps
• How To Get Ready for Python Development
  • Assumptions
  • Steps
    • First-Time Setup
    • Working on a Repo
• How-to get your repository docs on docs.openedx.org
  • Assumptions
  • Steps
• How To Maintain a Repository
  • GitHub Issues is Enabled
  • A catalog-info.yaml File Exists
  • Python Dependency Update Automation is Enabled
  • Javascript Dependency Update Automation is Enabled
  • A Well-Formed README Exists
  • Your CCs are Aligned With Your Expectations as Maintainer
  • Congratulations!
• Maintaining Translations on Your Repo
  • How To Use Atlas
  • Is It Working?
  • What To Do If It’s Not Working?
• How To Manage a uv Dependency Version Matrix
  • Assumptions
  • Steps: Adding a new version
  • Steps: Retiring a version
• Ongoing Maintainer’s Tasks
  • Assumptions
  • Hold Yourself to Community Standards
  • GitHub Notifications
  • Responding to Issues
  • Responding to PRs
  • Managing Upgrade PRs
  • Approving GitHub Actions for new committer PRs
  • Participating in Forum Discussions
  • Transparent Development Expectations
  • Adding a Maintainer
  • Stepping Down as Maintainer
• How to Switch to the sphinx-book-theme for Documentation
  • Assumptions
  • Steps
• How to Set Up Github Action to Monitor Python Coverage
  • Features of the Action
  • Setting Up a Repository

---

Feedback