Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
67,959 Commits 1 Branch 0 Tags
master
Commit Graph

59 Commits

Author SHA1 Message Date
Kyle McCormick
5a411c20bd build: Update README, CODEOWNERS, catalog-info with new repo name (#37939) 
Referenced GH team names have been updated accordingly as well.

Closes: https://github.com/openedx/openedx-platform/issues/37904
 2026-01-26 17:54:58 +00:00
github-actions[bot]
97fede2875 feat: Upgrade Python dependency edx-enterprise (#37920) 
* feat: Upgrade Python dependency edx-enterprise

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

* fix: typo fix to trigger tests

---------

Co-authored-by: kiram15 <31229189+kiram15@users.noreply.github.com>
 2026-01-20 17:09:07 -07:00
Feanil Patel
6062c04e8a docs: Apply suggestion from @kdmccormick 
Co-authored-by: Kyle McCormick <kyle@axim.org>
 2026-01-13 14:17:59 -05:00
Feanil Patel
d5cb793f8b docs: Update the supported python version in the README. 
We have tested and now work with Python 3.12 so update the readme so
that people are using the latest version.
 2026-01-12 15:58:53 -05:00
Feanil Patel
1a977c8f5b docs: Document what MFEs are on by default 
Document which MFEs are currently on by default in the edx-platform code
and where the code expects those MFEs to be running including the
settings that can be overridden to change those default locations.
 2025-09-18 11:23:06 -04:00
Feanil Patel
bcbbf38256 docs: Update README.rst 
* Update supported OSes
* Fix a formatting issue.
 2025-07-28 11:11:33 -04:00
Daniel Wong
de036a8d5d docs: update dev requirements file name in README 2025-05-13 14:52:16 -06:00
Sarina Canelake
d2b7e64697 docs: Point to nvmrc for the official Node version (#36533) 2025-04-16 15:45:58 -04:00
Kyle McCormick
f8775087a3 docs: Nix "service-oriented" (#36417) 
In acknowledgement of the architectural direction of the
openedx codebase over the past 4 years.
 2025-03-20 13:58:43 -04:00
Feanil Patel
a29ef71f8d fixup! docs: Declare Ubuntu 24.04 support and add a note about codejail. 2024-11-20 13:44:17 -05:00
Feanil Patel
5570f82529 docs: Declare Ubuntu 24.04 support and add a note about codejail. 2024-11-20 10:24:16 -05:00
Feanil Patel
cf0be34712 docs: Explicitly declare the OS version that edx-platform supports. 2024-10-22 16:54:40 -04:00
Tim McCormack
869b621b86 build: Remove newrelic from dependencies; note system deps in README (#35683) 
We don't need a dependency on `newrelic` in edx-platform, since it's
already brought in via edx-django-utils, which is where telemetry
dependencies belong anyhow.

Ran `make compile-requirements` to apply changes to lockfiles.

(Additional context: We may end up DEPRing the direct dependencies in
edx-django-utils as well and requiring deployers to install newrelic
separately. In any case, there aren't any places in openedx code that is
installed into the LMS or CMS that import newrelic directly.)

Also, update README to note system package dependencies that are required
for installing edx-platform deps. I had to reinstall my laptop and ran
into this again and wanted to actually document it this time.
 2024-10-21 18:15:54 +00:00
Feanil Patel
0f975adc14 feat: Be able to login to bare-metal studio easily. (#35172) 
* feat: Be able to login to bare-metal studio easily.

Updating the documentation and the devstack.py files so that if you're
running bare-metal you can easily setup studio login via the LMS.

I also added the Ports that the various MFEs expect to the runserver
scripts so that it's easier to run those locally as well.

Co-authored-by: Kyle McCormick <kyle@axim.org>
 2024-09-20 08:51:51 -04:00
Feanil Patel
c8aabe4792 Merge pull request #34937 from openedx/feanil/update_docs 
docs: Add a note about the second DB that needs to be migrated.
 2024-06-18 11:22:14 -04:00
Kyle McCormick
448acc95f6 docs: remove mention of py38 compatibility from readme (#35001) 
Support was removed about a week ago
 2024-06-17 13:51:23 -04:00
Feanil Patel
680c9c6d39 docs: Add a note about the second DB that needs to be migrated. 
CSMH lives in a second database named `student_moudule_history` and so
you need to run migrations on that to create the csmh_extended table.
 2024-06-06 15:34:54 -04:00
Kyle McCormick
d39bd32768 docs: improve 'bare metal' docs and add static assets reference (#34678) 2024-05-02 10:10:52 -04:00
Sarina Canelake
8dadac636d docs: Point to Tutor in README 
Since we have deprecated Devstack, update the platform README to point to Tutor.
 2024-04-09 10:45:47 -04:00
Feanil Patel
0d92c3ebcc docs: Update README with new Mongo Version 
Support was verified via https://github.com/openedx/edx-platform/pull/34213
but we forgot to update the README with this info.
 2024-03-13 15:25:39 -04:00
Feanil Patel
063204161c docs: Update the security e-mail address. 
This repository is now managed by the Axim Collaborative and security issues
with it should be reported to security@openedx.org instead of security@edx.org

This work is being done as a part of https://github.com/openedx/wg-security/issues/16
 2023-10-31 12:37:55 -04:00
Robert Raposa
92e6c071d1 docs: move up docs link in README (#33281) 
The documentation section, which now has an edx-platform
specific doc link, was moved closer to the top of the README
to make it stand out more.
 2023-09-19 11:30:22 -04:00
Robert Raposa
5953b1140b docs: update documentation link in README (#33244) 2023-09-14 11:56:17 -04:00
Rebecca Graber
a11eba003d chore: Update README.rst with People section (#32981) 2023-08-10 12:05:19 -04:00
Rebecca Graber
5d11db24c4 chore: add maintainership documentation (#32970) 
Add catalog-info.yaml and update the README
 2023-08-10 10:54:50 -04:00
Feanil Patel
f7a3faa3e0 docs: Update the issue tracker section of the README. (#32354) 
* docs: Update the issue tracker section of the README.

Fixes https://github.com/openedx/edx-platform/issues/32235

Ideally, we'd update the whole readme to better match the new
maintainers standards and we should still do that but for now we'll just
update this egregiously incorrect section quickly.

Co-authored-by: Robert Raposa <rraposa@edx.org>
 2023-06-02 13:16:52 -04:00
Feanil Patel
4e043de248 docs: Update the readme. 
* Re-rule the file to match the current standards.
* Add a "Dependencies" section that outlines the interpreter and service
  dependencies for the edx-platform codebase.  It's not comprehensiv but
  I couldn't find anything anywhere that was so start with something
  here for now.
 2023-05-09 10:38:00 -04:00
Feanil Patel
14177da52c docs: Update the contributing link. 
Link to the org-wide guidilines page.
 2023-04-20 14:21:01 -04:00
Mohammad Ahtasham ul Hassan
78999c8af5 fix: fix CI badge (#31097) 2022-10-05 14:35:47 +05:00
Sarina Canelake
4a2f231302 fix: fix github url strings (org edx -> openedx) 2022-09-15 14:52:28 -04:00
Edward Zarecor
4b110c2fe9 fix: Add acronym expansion 
Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>
 2022-09-12 13:01:33 -04:00
Edward Zarecor
01c4e1f69b fix: add new newline. 
Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>
 2022-09-12 13:00:12 -04:00
Edward Zarecor
0dacf83789 fix: updated name 2022-09-07 17:13:59 -04:00
Edward Zarecor
501a1b62d7 fix: Update README.rst 
Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>
 2022-09-07 17:13:59 -04:00
Edward Zarecor
d3ff7adef7 fix: Update README.rst 
Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>
 2022-09-07 17:13:59 -04:00
Edward Zarecor
6982807a52 fix: add link, and dash. 
Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>
 2022-09-07 17:13:59 -04:00
Edward Zarecor
9d42ed5d7e fix: actually remove the badge. 2022-09-07 17:13:59 -04:00
Edward Zarecor
07f5f04fad fix: removing PyPi publish badge 2022-09-07 17:13:59 -04:00
Edward Zarecor
3aca32c49c fix: initial efforts to create useful, standard readme with purpose. 2022-09-07 17:13:59 -04:00
Feanil Patel
1f0cb258ef fix: Update the slack invite link. 
Point to the openedx.org shortcut which we can update as needed.
 2022-07-11 10:55:36 -04:00
Ned Batchelder
513b682005 docs: a better mention of Devstack 2022-01-26 13:32:16 -08:00
youpsla
fa3ae19aa8 fix: broken link to developer stack in README.rst 
Make the text in paragraph the same as in the link definition.
 2021-12-08 18:48:51 +01:00
Robert Raposa
6cbdc92ca0 docs: update README (#28026) 
Minor change, mostly to force a deployment. :)
 2021-08-11 16:23:43 -04:00
Ned Batchelder
80301ce8c7 docs: update CLA links to point to Docusign form. 
The openedx.org/cla link is a redirection to Docusign.  If the form has
to change in the future, we can update the redirect at openedx.org.

There are other changes to make to CONTRIBUTING.rst, but those will have
to wait.
 2021-02-25 15:57:12 -05:00
Kyle McCormick
0b0a9ca07a Replace outdated 16.04 link with link to install options (#25875) 
The linked wiki page will be kept updated, so that this
README doesn't need to be updated every release.
 2020-12-14 15:13:43 -05:00
Ned Batchelder
c5d6888e60 Bring this file into the 21st century 2019-10-07 14:11:10 -04:00
Cory Lee
c6a4ff93b9 README change 2019-05-08 20:05:40 -04:00
Ned Batchelder
137d49b5c0 Fix references to open.edx.org 2019-01-23 10:51:42 -05:00
Cory Lee
3c129e9104 Revert "small change to test PR messaging on deployment" 
This reverts commit 7f11a8bfa1.
 2018-09-19 14:28:04 -04:00
Ben Holt
7f11a8bfa1 small change to test PR messaging on deployment 2018-09-11 13:41:22 -04:00