Andal.LND/frontend-app-learning
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update edx.rtd.io links to docs.openedx.org (#1654)

Browse Source 
* docs: Update edx.rtd links to their new homes

* docs: Update README to not prescribe a version of Node
This commit is contained in:
Sarina Canelake
2025-03-26 08:13:44 -04:00
committed by GitHub
parent 81b621195e
commit d5a092b220
3 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.env.development
View File

@@ -8,7 +8,7 @@ APP_ID='learning'
BASE_URL='http://localhost:2000' BASE_URL='http://localhost:2000'
CONTACT_URL='http://localhost:18000/contact' CONTACT_URL='http://localhost:18000/contact'
CREDENTIALS_BASE_URL='http://localhost:18150' CREDENTIALS_BASE_URL='http://localhost:18150'
CREDIT_HELP_LINK_URL='https://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_credit_courses.html#keep-track-of-credit-requirements' CREDIT_HELP_LINK_URL='https://help.edx.org/edxlearner/s/article/Can-I-receive-college-credit-or-credit-hours-for-my-course'
CSRF_TOKEN_API_PATH='/csrf/api/v1/token' CSRF_TOKEN_API_PATH='/csrf/api/v1/token'
DISCOVERY_API_BASE_URL='http://localhost:18381' DISCOVERY_API_BASE_URL='http://localhost:18381'
DISCUSSIONS_MFE_BASE_URL='http://localhost:2002' DISCUSSIONS_MFE_BASE_URL='http://localhost:2002'

2
.env.test
View File

@@ -8,7 +8,7 @@ APP_ID='learning'
BASE_URL='http://localhost:2000' BASE_URL='http://localhost:2000'
CONTACT_URL='http://localhost:18000/contact' CONTACT_URL='http://localhost:18000/contact'
CREDENTIALS_BASE_URL='http://localhost:18150' CREDENTIALS_BASE_URL='http://localhost:18150'
CREDIT_HELP_LINK_URL='https://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_credit_courses.html#keep-track-of-credit-requirements' CREDIT_HELP_LINK_URL='https://help.edx.org/edxlearner/s/article/Can-I-receive-college-credit-or-credit-hours-for-my-course'
CSRF_TOKEN_API_PATH='/csrf/api/v1/token' CSRF_TOKEN_API_PATH='/csrf/api/v1/token'
DISCOVERY_API_BASE_URL='http://localhost:18381' DISCOVERY_API_BASE_URL='http://localhost:18381'
DISCUSSIONS_MFE_BASE_URL='http://localhost:2002' DISCUSSIONS_MFE_BASE_URL='http://localhost:2002'

7
README.rst
View File

@@ -41,9 +41,8 @@ Cloning and Setup
git clone https://github.com/openedx/frontend-app-learning.git git clone https://github.com/openedx/frontend-app-learning.git
2. Use node v20.x. 2. Use the version of Node specified in ``.nvmrc``.
The current version of the micro-frontend build scripts supports node 18.
Using other major versions of node *may* work, but this is unsupported. For Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes an ``.nvmrc`` file to help in setting the convenience, this repository includes an ``.nvmrc`` file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_. correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
@@ -131,7 +130,7 @@ Deployment
The Learning MFE is similar to all the other Open edX MFEs. Read the Open The Learning MFE is similar to all the other Open edX MFEs. Read the Open
edX Developer Guide's section on edX Developer Guide's section on
`MFE applications <https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/developers_guide/micro_frontends_in_open_edx.html>`_. `MFE applications <https://openedx.github.io/frontend-platform/>`_.
Plugins Plugins
======= =======
@@ -145,7 +144,7 @@ Environment Variables
This MFE is configured via environment variables supplied at build time. This MFE is configured via environment variables supplied at build time.
All micro-frontends have a shared set of required environment variables, All micro-frontends have a shared set of required environment variables,
as documented in the Open edX Developer Guide under as documented in the Open edX Developer Guide under
`Required Environment Variables <https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/developers_guide/micro_frontends_in_open_edx.html#required-environment-variables>`_. `Required Environment Variables <https://openedx.github.io/frontend-platform/>`_.
The learning micro-frontend also supports the following additional variables: The learning micro-frontend also supports the following additional variables: