Architectural Decision Log

This log lists the architectural decisions for the QHAna Plugin Runner.

• 1. Template
• 2. Use Markdown Architectural Decision Records
• 3. Plugin Runner as Seperate Project
• 4. Use Python
• 5. Use Flask Template
• 6. Use Celery Task Queue
• 7. Plugins Must Provide Metadata
• 8. Use MICRO-Frontends to Expose Algorithm Parameters
• 9. Always Pass Files as URLs
• 10. Complex Plugin Interactions
• 11. Preprocessing Metadata to Apply the Same Processing to New Data [undecided]
• 12. Repeating Steps in Multi-Step Plugins [undecided]
• 13. Specify Additional Endpoints to used by Other Plugins
• 14. Add a recipe data type [undecided]
• 15. Subscribing for plugin updates
• 16. Data inputs in substeps
• 17. Schema links
• 18. Celery Task Testing Strategy
• 19. Co-locate plugin tests with plugin code
• 20. Pipeline adaptation for comparing hierarchical Subparts (Muse4Music)
• 21. Pipeline adaption for non-tree taxonomies

For new ADRs, please use template.md as basis.

Note

The numbering of the ADRs should match the numbers in the documentation except for the ADR and template from the MADR repository. (1 -> template.md; 2 -> 0000-….md; 3 -> 0003-….md)

See also

More information on MADR is available at https://adr.github.io/madr/.

General information about architectural decision records is available at https://adr.github.io/.