Skip to content

Commit

Permalink
docs: ADR for lightweight extension points
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Feb 27, 2024
1 parent c76a89c commit 56f2fa9
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs/decisions/0003-lightweight-extension-points.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
Lightweight extension points
############################

.. The title should be a short noun phrase. For example, "1. Django IDA" or "9. LDAP for Multitenant Integration"; filename should be lowercase with punctuation removed and spaces replaced by dash
Status

******

**Draft** *2024-02-27*

Context

*******

.. This section describes the forces at play, including technological, political, social, and project local. These forces are probably in tension, and should be called out as such. The language in this section is value-neutral. It is simply describing facts.
Here we can add:

What instructors need and why (external response processing)

What's currently available in ORA to do so (instructor → configurations and what ora offers out of the box / developer POV → extension methods)

Decision

********

.. This section describes our response to these forces. It is stated in full sentences, with active voice. "We will …"
Here we can add:

Open extension points for plugin processing / interaction, no need for new step? how to argue that?

Or say: 1st step for new interactions outside ORA??

Consequences

************

.. This section describes the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.
Or say: 1st step for new interactions outside ORA??

Send data to services

Modify student steps? what are they call?

Rejected Alternatives

*********************

.. This section lists alternate options considered, described briefly, with pros and cons.
FOR THE MOMENT: a new step

References

**********

.. (Optional) List any additional references here that would be useful to the future reader. See `Documenting Architecture Decisions`_ for further input.
.. _Documenting Architecture Decisions: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions

0 comments on commit 56f2fa9

Please sign in to comment.