Commit Graph

34 Commits

Author SHA1 Message Date
Kyle McCormick
423acd32f9 docs: retroactively add ADR for dissolution of sub-projects (#30779) 2022-07-26 11:33:01 -04:00
connorhaugh
45c2858d61 Revert "feat: FC-0001 Remove Persistent Course Grades Flags (#30540)" (#30744)
This reverts commit 4a9243ef9f.
2022-07-19 13:45:31 -04:00
Sagirov Evgeniy
4a9243ef9f feat: FC-0001 Remove Persistent Course Grades Flags (#30540)
* feat: revert Fix certificate generation without persistent grades

* feat: Remove Persistent Course Grades Flags

* test: update tests
2022-07-19 11:30:37 -04:00
Rebecca Graber
05b4aa8d4b docs: ADR with guidance for new applications (#30053) 2022-06-06 11:36:27 -04:00
Saksham Agrawal
e6caca26c2 docs: ADR for library reference content block (#29633) 2022-05-31 10:49:53 -04:00
Kyle McCormick
51fccf06d1 docs: add ADR to declare distinction between 'cms' and 'studio' 2022-01-04 15:07:04 -05:00
Michael Terry
ff453d1ad6 chore: delete ancient unused ADRs for system dashboard
This is long deprecated and these ADRs just document why it doesn't
exist. They've explained that long enough that we can just remove
this.
2021-11-23 15:47:27 -05:00
ayub02
9ac8e59c26 [ERTE-22-2] docs: created ADR for course completion events (#28424)
* docs: created ADR for course completion events

Co-authored-by: Aamir Ayub <aamirayub@Arbisofts-MacBook-Pro.local>
2021-10-27 14:56:26 +05:00
David Ormsbee
da2bae21ae docs: ADR for Limit LMS Modulestore access
Explains why we want to limit Modulestore access, along with some
guidelines about what to use instead.
2021-10-07 11:10:24 -04:00
Binod Pant
33cdf634b4 refactor: Extract core functionality of enrollment api in a python api to avoid REST calls from edx-enterprise (#28202)
* feat: Refactor out non REST portions of enrollment api from enrollment POST method

For use with edx-enterprise to avoid making REST calls for bulk enrollment and other use cases

ENT-4746

* feat: Remove unused test

Testing is covered by test_views

* refactor: isort

isort fixes

* docs: ADR for why this change

ADR

ENT-4746

* test: Fix test failure by restoring course_id to correct object

* test: Test fix

* refactor: pylint fixes

* refactor: raise from to avoid pylint error

* refactor: Start to work toward a util in enterprise_support instead of refactoring this endpoint

* feat: Add util function in enterprise_support to eventually handle enrollment, only used by bulk enrollment for now

* feat: One more revised idea, this time low risk in edx platform and also helps address enterprise specific flow. testing pending

* feat: syntax and unused constant

* feat: Restore view and add new util function to use in edx-enterprise instead

* feat: breakpoint

* unused import

* feat: don't fail on existing enrollment

* docs: ADR update

* docs: docstring minor update

* test: unit test add_user_to_course_cohort

* refactor: imports

* feat: remove unused error classes

* refactor: lint

* test: Test cases

* test: Two more tests for negative cases

* feat: missing init.py file

* test: Fix tests to use correct user mock

* unused import

* refactor: Review feedback, test fixes, needs rebase now

* feat: rebase changes

* feat: keep audit_log with similar logic as in the view

* refactor: Review feedback, test constant usage
2021-07-21 16:59:45 -04:00
Michael Terry
35f78a3241 feat!: remove all email_marketing djangoapp code
This djangoapp was designed for talking to sailthru, in a fairly
edx.org-specific way. Nowadays, edx.org doesn't need this code and
if other installations do, it's better off as a more distinct
plugin anyway, rather than direct support in the platform.

I've moved the one signal that was still useful (calling
segment.identify() whenever user fields change) into user_authn.

And I've left the EmailMarketingConfiguration model alone for now,
but will remove that shortly. Nothing uses it as of this commit.

AA-607
DEPR-139
2021-05-03 16:39:01 -04:00
Kyle McCormick
dfa60a5e92 docs: update sys.path hacks ADR & add upgrade guide
The timeline of the import_shims removal has evolved
over time; notably, we are keeping the import_shims
in Lilac in order to make any lingering old-style
import paths obvious to operators.

Update the ADR to reflect this. Also, add a table
mapping old import paths to new ones.
2021-03-08 12:49:31 -05:00
Feanil Patel
8925756f11 doc: Add some docs for how rate-limiting works. (#26475)
* doc: Add a decision around rate-limiting in edx-platform

While looking into whether a change to how we handle RateLimitExceptions
would impact logins, I learned the following about the current state of
how rate limiting works in our login flows.  Based on what I learned, I captured
the current state as well as decisions on how we should rate limit in the future.
2021-02-17 13:16:57 -05:00
David Ormsbee
5353324c80 Merge pull request #26145 from edx/ormsbee/course-outline-publish-tnl-7733
Push Course Outlines to learning_sequences on publish.
2021-01-28 10:21:11 -05:00
David Ormsbee
d531d38ec7 Fix formatting on interapp APIs extension ADR.
The numbered lists were not written correctly.
2021-01-28 09:56:38 -05:00
Feanil Patel
c5913a58d5 Add an ADR about secret key usage. (#26146)
Add an ADR about secret key usage.

Don't use secret keys for use cases which would result in breakage upon
rotation and which might slow down the act of rotation.
2021-01-25 13:35:49 -05:00
Kyle McCormick
090e10683c Rename sys_path_hacks/ to import_shims/
The old folder name is somewhat confusing, because the
folder contains shims to _compensate for the removal
of sys.path hacks_, but does not contain the sys.path
hacks themselves.

Furthermore, this import_shims/ system could also be
used for other import path changes, such as turning
the locally-installed packages in common/lib/
into regular, importable modules
(e.g. `from common.lib.xmodule import abc` instead of
`from xmodule import abc`). So, a name that is not
specific to the sys.path hacks may be better
in the medium-to-long term.

Along the same lines, we also rename SysPathHackWarning
to DeprecatedEdxPlatformImportWarning.
2020-10-30 10:20:48 -04:00
Kyle McCormick
4847a18a66 Remove sys.path modification for Studio; use sys_path_hacks instead
Also, tweak the un_sys_path.sh script.
2020-10-19 09:34:31 -04:00
Kyle McCormick
b82ac1fc16 Add sys_path_hacks/warn.py for easier modification of path warnings 2020-09-30 08:56:44 -04:00
Calen Pennington
7cbfc8de40 Add an ADR capturing sys.path removal justifications 2020-09-23 10:05:37 -04:00
David Ormsbee
607400c403 ADR for the role of XBlock
Architecture Decision Record detailing the history of XBlock and
where we're going with it in the platform.
2020-08-26 10:37:37 -04:00
David Ormsbee
6d8fba77b2 ADR for LMS/Studio subdomain boundaries (TNL-7323)
Introduce an Architectural Decision Record about the boundaries
and responsibilities of Studio (Content Authoring) and the LMS
(Learning Experience). These are not new ideas. This is just
explicitly writing down the many local decisions that have been
made for years (Block Transformers, edx-when, grading, etc.), and
showing how they add together to a set of high level principles.

I hope to eventually have docs describing Studio/LMS's relation
to other subdomains in Open edX.
2020-07-11 13:05:18 -04:00
Feanil Patel
f95158458e Merge pull request #23888 from edx/feanil/update_bokchoy_adr
Bokchoy ADR Updates.
2020-05-05 15:16:42 -04:00
Feanil Patel
307986575e Make updates based on feedback. 2020-05-05 09:54:05 -04:00
Feanil Patel
55303e9233 Bokchoy ADR Updates. 2020-05-04 11:37:46 -04:00
Feanil Patel
c0f28a73ca Make updates to better match up with OEP-45 2020-04-30 11:51:33 -04:00
Feanil Patel
db8348f733 Added more info based on feedback. 2020-04-30 11:51:33 -04:00
Feanil Patel
27b699e5a1 An initial draft of a decision around how we manage settings files. 2020-04-30 11:51:33 -04:00
Feanil Patel
98a657e849 Respond to feedback. 2020-03-25 12:23:46 -04:00
Feanil Patel
144982af8c Respond to PR feedback.
- Fix indenting.
- Small wording fixes.
2020-03-23 09:56:53 -04:00
Feanil Patel
d0f584ab7e Update based on feedback. 2020-03-19 16:12:23 -04:00
Feanil Patel
82c50458a1 Add a draft decision related to bokchoy experiment. 2020-03-19 10:57:14 -04:00
Nimisha Asthagiri
a943a2cb63 Top-level ADR-2: Inter-App APIs 2019-05-04 11:00:15 -04:00
Nimisha Asthagiri
2e549c0545 Top-level ADR-1: Courses in LMS
Refactored the previous best-practices document as an ADR.
Previous document: 07f588517b/docs/best_practices.rst
2019-05-04 10:22:36 -04:00