From ff68b720978d7bcff4519ee6c7c49ffa4b5bb8e9 Mon Sep 17 00:00:00 2001 From: Anton Melser Date: Wed, 10 Dec 2025 10:54:22 +0800 Subject: [PATCH 1/3] docs: remove obsolete app devstack readme sections Signed-off-by: Anton Melser --- README-template-frontend-app.rst | 88 ++++---------------------------- 1 file changed, 11 insertions(+), 77 deletions(-) diff --git a/README-template-frontend-app.rst b/README-template-frontend-app.rst index 15c49e6e..79bc6a75 100644 --- a/README-template-frontend-app.rst +++ b/README-template-frontend-app.rst @@ -42,91 +42,25 @@ by the new Fantastico storage engine. Getting Started =============== -Devstack Installation ---------------------- +Prerequisites +============= + +The Tutor_ platform is a prerequisite for developing an MFE. +Utilize `relevant tutor-mfe documentation`_ to guide you through +the process of MFE development within the Tutor environment. + +.. _Tutor: https://github.com/overhangio/tutor + +.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development .. note:: [TODO] Describe in detail how this MFE can be installed and set up for development - in a devstack. Include as many screenshots as you can to make your guide + with tutor. Include as many screenshots as you can to make your guide easier to follow! Use the following steps as an example: -Follow these steps to provision, run, and enable an instance of the -[PLACEHOLDER] MFE for local development via the `devstack`_. - -.. _devstack: https://github.com/openedx/devstack#getting-started - -#. To start, clone the devstack repository as a child of an arbitrary ``~/workspace/`` directory. - - .. code-block:: - - mkdir -p ~/workspace/ - cd ~/workspace/ - git clone https://github.com/openedx/devstack.git - -#. Configure default services and setup devstack - - Create a ``devstack/options.local.mk`` file with only the services required. - Commonly, this will just be the LMS: - - .. code-block:: - - DEFAULT_SERVICES ?= \ - lms - -#. Start the devstack with: - - .. code-block:: - - cd devstack - make dev.pull - make dev.provision - make dev.up - -#. In an LMS shell, enable the ``ENABLE_[PLACEHOLDER]_MICROFRONTEND`` feature flag: - - .. code-block:: - - make lms-shell - vim /edx/etc/lms.yml - --- - FEATURES: - ENABLE_[PLACEHOLDER]_MICROFRONTEND: true - - Exit the shell and restart the LMS so changes take effect: - - .. code-block:: - - make lms-restart - -#. Create and enable the waffle flag required to redirect users to the MFE, - enabling it for everyone: - - .. code-block:: - - make lms-shell - ./manage.py lms waffle_flag --create --everyone [PLACEHOLDER].redirect_to_microfrontend - -#. Start this MFE with: - - .. code-block:: - - cd frontend-app-[PLACEHOLDER] - nvm use - npm ci - npm start - -#. Finally, open the MFE in a browser - - Navigate to `http://localhost:8080 `_ to open the - MFE. This is what it should look like if everything worked: - - .. figure:: ./docs/images/template.jpg - - "Polycon marking template" by mangtronix is licensed under CC BY-SA 2.0. - Configuration ------------- From 88347a1fa14904915f30c80270e5bae4dd1b4f90 Mon Sep 17 00:00:00 2001 From: Anton Melser Date: Wed, 10 Dec 2025 10:57:30 +0800 Subject: [PATCH 2/3] docs: remove refs to obsolete devstack in readme Signed-off-by: Anton Melser --- README.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index dee54af5..15273ebd 100644 --- a/README.rst +++ b/README.rst @@ -31,14 +31,8 @@ tab. 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 -to the `relevant tutor-mfe documentation`_ to get started using it. - -.. _Devstack: https://github.com/openedx/devstack +`Tutor`_ is currently recommended as the development environment for your +new MFE. You can refer to the `relevant tutor-mfe documentation`_ to get started using it. .. _Tutor: https://github.com/overhangio/tutor From b6e20b8ecf46aebecb9ab726eac5ef93588127f0 Mon Sep 17 00:00:00 2001 From: Anton Melser Date: Wed, 10 Dec 2025 10:44:01 +0800 Subject: [PATCH 3/3] docs: Generify currently supported node version --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 15273ebd..1e5470db 100644 --- a/README.rst +++ b/README.rst @@ -48,12 +48,12 @@ created when copying this template above. ``git clone https://github.com/openedx/frontend-app-[PLACEHOLDER].git`` -2. Use node v18.x. +2. Use the version of Node specified in the ``.nvmrc`` file. - The current version of the micro-frontend build scripts support node 18. - 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 - correct node version via `nvm `_. + The current version of the micro-frontend build scripts supports the version of Node found in ``.nvmrc``. + 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 + correct node version via `nvm `_. 3. Install npm dependencies: