This repository has been archived by the owner on Apr 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #81 from openedx/bmtcril/depr-repository
docs: ADR to DEPR this repository in favor of platform-plugin-aspects
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
0002 Rename and Re-scope This Repository | ||
######################################## | ||
|
||
Status | ||
****** | ||
|
||
Accepted | ||
|
||
Context | ||
******* | ||
|
||
As development of the Aspects project (formerly OARS) has continued, this repository has become more tightly bound to Aspects itself. To our knowledge no other adoption of this repository has taken place. As such, the maintainers would like to make this explicit and widen the scope of the repository to include all edx-platform plugin functionality for Aspects. | ||
|
||
Decisions | ||
********* | ||
|
||
* We will deprecate this repository and move the existing functionality to the platform-plugin-aspects repository | ||
* We will deprecate the PyPI project openedx-event-sink-clickhouse in favor of a combined platform-plugin-aspects project | ||
* We will ensure that all of the existing functionality will be moved, and can be turned on and off via configuration so any current use cases of this repository will not be forced to use other functionality of the new repository | ||
|
||
Consequences | ||
************ | ||
|
||
* We will need to update the PyPI project name and mark the old project as deprecated | ||
* We will need to upgrade tutor-contrib-aspects to use the new PyPI project | ||
* Anyone using the current project will need to change their usage to the new repository, and update their configuration | ||
|
||
Rejected Alternatives | ||
********************* | ||
|
||
* Maintaining several different plugins, they are going to be too tightly bound to the Aspects release and should be versioned together |