Skip to content

Commit

Permalink
docs: remove deep understanding of the platform disadvantage
Browse files Browse the repository at this point in the history
  • Loading branch information
@mariajgrimaldi @sarina
mariajgrimaldi authored and sarina committed Dec 11, 2024
1 parent cedc4ec commit 61cc5aa
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions source/developers/concepts/hooks_extension_framework.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,9 @@ The Hooks Extension Framework is designed to provide a stable and maintainable w
| **Disadvantages** | - Can increase complexity in debugging and maintenance because it adds more processing layers. | - Separation from the separation from the upstream project makes long-term maintenance challenging. |
| | - Limited by existing events and filters available in the Open edX ecosystem, although new events and | - High maintenance burden for upgrades and compatibility. |
| | filters can be proposed and added to the framework. | - Requires manual integration with the Open edX platform for each new release. |
| | - Might increase complexity in plugins for highly customized features. | - Requires deep understanding of the platform to modify it. |
| | - Although it is not recommended to do so, a plugin developer might introduce an edx-platform dependency, | - Not being able to be reused by the community. |
| | mainly when using filters, when there is no alternative for getting certain types of data. | - Difficult to test in isolation due to highly coupled implementations. |
| | - Might increase complexity in plugins for highly customized features. | - Not being able to be reused by the community. |
| | - Although it is not recommended to do so, a plugin developer might introduce an edx-platform dependency, | - Difficult to test in isolation due to highly coupled implementations. |
| | mainly when using filters, when there is no alternative for getting certain types of data. | |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Community Compatibility** | High, as the community encourages reusable implementations and the contribution of new extension points. | Low, as changes in forks are usually extremely customized not designed for others to reuse. Also, |
| | | community discoverability is low when changes are kept in a fork, making it harder to share and collaborate. |
Expand All @@ -197,7 +197,7 @@ The Hooks Extension Framework is designed to provide a stable and maintainable w
| **Upgrade Compatibility** | High, due to backward compatibility policies. | Low, as forks must manually integrate their changes with the Open edX platform for each new release. |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+

When implementing a new feature, look into how the Hooks Extension Framework can help you extend the platform before considering forking the Open edX platform. You should consider the advantages and disadvantages of each approach to determine the best fit for your use case and long-term goals.
When implementing a new feature, look into how the Hooks Extension Framework can help you extend the platform before considering forking the Open edX platform. You should consider the advantages and disadvantages of each approach to determine the best fit for your use case and long-term goals.

.. note:: If you think your feature should be part of the core instead of an extension, consider making a `Product Proposal`_.

Expand Down

0 comments on commit 61cc5aa

Please sign in to comment.