From 94c059391bf7e3fb55d4f8b8031fc2dd3dc04bbe Mon Sep 17 00:00:00 2001 From: Ali Salman <88362079+Ali-Salman29@users.noreply.github.com> Date: Fri, 9 Aug 2024 11:01:09 +0200 Subject: [PATCH] docs: update development steps Add the step for mounting the "edx-platform" with the "forum_v2" branch. --- README.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 622569c2..d57e1f2b 100644 --- a/README.rst +++ b/README.rst @@ -61,31 +61,36 @@ There are no changes needed in the `Discussion MFE `_ plugin. Follow these steps to accomplish this: -1. Clone the forum repo:: +1. Mount the edx-platfrom: + + Mount the edx-patfrom using `forum_v2 `_ branch. + The branch contains updates for better logging to test the Forum V2 APIs + +2. Clone the forum repo:: git clone git@github.com:edly-io/forum.git -2. Mount the repo:: +3. Mount the repo:: tutor mounts add path/to/forum/repo -3. Install this plugin:: +4. Install this plugin:: tutor plugins install https://gist.githubusercontent.com/taimoor-ahmed-1/9e947a06d127498a328475877e41d7c0/raw/6152bdc312f941e79d50e2043f00d3d059de70a7/forum-v2.py -4. Enable the plugin:: +5. Enable the plugin:: tutor plugins enable forumv2 -5. Save Changes:: +6. Save Changes:: tutor config save -6. Build the openedx-dev Docker image:: +7. Build the openedx-dev Docker image:: tutor images build openedx-dev -7. Launch the platform:: +8. Launch the platform:: tutor dev launch