From fc222cc76ce75c03e5961d39cfb420f8756938fa Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Fri, 21 Mar 2025 11:15:04 -0400 Subject: [PATCH] Update README with Tutor instructions; update outdated edx.rtd.io links (#1203) * docs: remove Devstack mentions from README instructions * docs: Update edx.rtd.io links to point at new homes * docs: Apply code review suggestions Co-authored-by: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com> --------- Co-authored-by: Brian Smith <112954497+brian-smith-tcril@users.noreply.github.com> --- README.rst | 40 ++++--------------- .../NotificationPreferences.jsx | 2 +- 2 files changed, 8 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index df5d6a5..746829e 100644 --- a/README.rst +++ b/README.rst @@ -25,40 +25,13 @@ Getting Started Prerequisites ============= -The `devstack`_ is currently recommended as a development environment for your -new MFE. If you start it with ``make dev.up.lms`` that should give you -everything you need as a companion to this frontend. - -Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer +`Tutor`_ is currently recommended as a development environment for your +new MFE. Please refer to the `relevant tutor-mfe documentation`_ to get started using it. -.. _Devstack: https://github.com/openedx/devstack - .. _Tutor: https://github.com/overhangio/tutor -.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development - -Installation -============ - -This MFE is bundled with `Devstack `_, see the `Getting Started `_ section for setup instructions. - -1. Install Devstack using the `Getting Started `_ instructions. - -2. Start up Devstack, if it's not already started. - -3. Log in to Devstack (http://localhost:18000/login ) - -4. Within this project, install requirements and start the development server: - - .. code-block:: - - npm install - npm start # The server will run on port 1997 - -5. Once the dev server is up, visit http://localhost:1997 to access the MFE - - .. image:: ./docs/images/localhost_preview.png +.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development Plugins ======= @@ -69,7 +42,7 @@ The parts of this MFE that can be customized in that manner are documented `here Environment Variables/Setup Notes ================================= -This MFE is configured via environment variables supplied at build time. All micro-frontends have a shared set of required environment variables, as documented in the Open edX Developer Guide under `Required Environment Variables `__. +This MFE is configured via the ``frontend-platform`` configuration module. For more information on MFE configuration see the `Configuration documentation`_. The account settings micro-frontend also supports the following additional variable: @@ -102,8 +75,9 @@ Example build syntax with a single environment variable: NODE_ENV=development ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build -For more information see the document: `Micro-frontend applications in Open -edX `__. +For more information see the document: `Configuration documentation`_ + +.. _Configuration documentation: https://openedx.github.io/frontend-platform/module-Config.html Cloning and Startup =================== diff --git a/src/notification-preferences/NotificationPreferences.jsx b/src/notification-preferences/NotificationPreferences.jsx index 9402cd3..2f43ca8 100644 --- a/src/notification-preferences/NotificationPreferences.jsx +++ b/src/notification-preferences/NotificationPreferences.jsx @@ -65,7 +65,7 @@ const NotificationPreferences = () => {
{intl.formatMessage(messages.notificationPreferenceGuideBody)}