docs: updating individual plugin READMEs

src/edx_sysadmin/README.rst

@@ -27,31 +27,13 @@ You do not need edx-sysadmin plugin. Just enable ``ENABLE_SYSADMIN_DASHBOARD`` f
 Installing The Plugin
 ---------------------
 
-You can install this plugin into any Open edX instance by using any of the following methods (See the note above for releases before `lilac`):
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
+* LMS
 
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install edx-sysadmin
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for "edx_sysadmin" and other "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS or CMS containers)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
-
-* Once you have installed the plugin you can visit ``<EDX_BASE_URL>/sysadmin`` to access the plugin features.
-
-``Note``: In some cases you might need to restart edx-platform after installing the plugin to reflect the changes.
+Once you have installed the plugin you can visit ``<EDX_BASE_URL>/sysadmin`` to access the plugin features.
 
 Configurations
 --------------

src/edx_username_changer/README.rst

@@ -11,28 +11,11 @@ It only supports koa and latest releases of Open edX.
 Installing The Plugin
 ---------------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
-**Option 1: Install from PyPI**
+Installation required in:
 
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install edx-username-changer
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all plugins in the src directory
-3. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS containers)
-4. Run a shell in the machine/container running Open edX, and install this plugin using pip
-
-
-``Note``: In some cases you might need to restart edx-platform after installing the plugin to reflect the changes.
+* LMS
 
 Configurations
 --------------

src/ol_openedx_canvas_integration/README.rst

@@ -48,27 +48,11 @@ Use ``0.1.1`` version of this plugin
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install ol-openedx-canvas-integration
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``pants build``
-3. Run ``pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* LMS
 
 Configuration
 ------------

src/ol_openedx_chat/README.rst

@@ -12,43 +12,12 @@ MIT's AI chatbot for Open edX
 Setup
 =====
 
-1) Add OL chat as a dependency
-------------------------------
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
-For local development, you can use one of the following options to add
-this as a dependency in the ``edx-platform`` repo:
+Installation required in:
 
--  **Install directly via pip.**
-
-   ::
-
-      # From the devstack directory, run bash in a running LMS container...
-      make dev.shell.lms
-
-      # In bash, install the package
-      source /edx/app/edxapp/edxapp_env && pip install ol-openedx-chat==<version>
-
-      # Do the same for studio
-      make dev.shell.studio
-
-      # In bash, install the package
-      source /edx/app/edxapp/edxapp_env && pip install ol-openedx-chat==<version>
-
--  **Build the package locally and install it**
-
-   ::
-
-      Follow these steps in a terminal on your machine:
-
-      1. Navigate to open-edx-plugins directory
-
-      2. If you haven't done so already, run "pants build"
-
-      3. Run "pants package ::". This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for "ol_openedx_chat" and other "ol_openedx_*" plugins in "open-edx-plugins/src"
-
-      4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use "docker cp" to copy these files into your LMS or CMS containers)
-
-      5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* LMS
+* Studio (CMS)
 
 Configuration
 =============

src/ol_openedx_checkout_external/README.rst

@@ -8,27 +8,11 @@ The plugin redirects the user the desired external ecommerce service upon clicki
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install ol-openedx-checkout-external
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* LMS
 
 Configuration
 -------------

src/ol_openedx_course_export/README.rst

@@ -7,27 +7,11 @@ A django app plugin to add a new API to Open edX to export courses to S3 buckets
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-.. code-block::
-
-    # If running devstack in docker, first open a shell in CMS (make studio-shell)
-
-    pip install ol-openedx-course-export
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your CMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* Studio (CMS)
 
 Configuration
 ------------

src/ol_openedx_course_structure_api/README.rst

@@ -7,43 +7,11 @@ A django app plugin to add a new API to Open edX to retrieve the JSON representa
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-.. code-block::
-
-    # run it in LMS container
-    pip install ol-openedx-course-structure-api
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-
-If running devstack, do the following 4 and 5 steps:
-
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: you can use docker cp to copy these files into your LMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
-
-If running tutor, do the following few steps:
-
-4. Extract ".tar.gz" file (e.g. tar command)
-5. Move the above extracted files to ``env/build/openedx/requirements/`` in tutor
-6. Create/Edit ``env/build/openedx/requirements/private.txt`` with this plugin files
-
-.. code-block::
-
-   -e ./ol-openedx-course-structure-api-0.1.0/
-
-7. Run ``tutor images build openedx``
-8. Run ``tutor local run lms ./manage.py lms print_setting INSTALLED_APPS`` to confirm the plugin is installed
-9. Restart tutor ``tutor local start``
+* LMS
 
 How To Use
 ----------

src/ol_openedx_git_auto_export/README.md

@@ -1,25 +1,11 @@
 #### Steps to install on edX platform:
 
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-    # If running devstack in docker, first open a shell in CMS (make studio-shell)
-
-    pip install ol-openedx-git-auto-export
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* Studio (CMS)
 
 Configuration
 ------------

src/ol_openedx_otel_monitoring/README.rst

@@ -7,27 +7,11 @@ This Django plugin integrates Open Telemetry, offering both tracing and metric f
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
+Installation required in:
 
-**Option 1: Install from PyPI**
-
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install ol-openedx-otel-monitoring
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your CMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* LMS
 
 Configuration
 ------------

src/ol_openedx_rapid_response_reports/README.rst

@@ -23,27 +23,11 @@ This plugin generates reports for `Rapid Response xBlock <https://github.com/mit
 Installation
 ------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
-**Option 1: Install from PyPI**
+Installation required in:
 
-.. code-block::
-
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install ol-openedx-rapid-response-reports
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all the "ol_openedx_*" plugins in "open-edx-plugins/src")
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS container)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+* LMS
 
 How To Use
 ----------

src/ol_social_auth/README.rst

@@ -11,29 +11,11 @@ Compatible with all edx releases
 Installing The Plugin
 ---------------------
 
-You can install this plugin into any Open edX instance by using any of the following methods:
+For detailed installation instructions, please refer to the `plugin installation guide <../#installation-guide>`_
 
-**Option 1: Install from PyPI**
+Installation required in:
 
-.. code-block::
-
-    # If running devstack in docker, first open a shell in LMS (make lms-shell)
-
-    pip install ol-social-auth
-
-
-**Option 2: Build the package locally and install it**
-
-Follow these steps in a terminal on your machine:
-
-1. Navigate to ``open-edx-plugins`` directory
-2. If you haven't done so already, run ``./pants build``
-3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all plugins in the src directory
-4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS or CMS containers)
-5. Run a shell in the machine/container running Open edX, and install this plugin using pip
-
-
-``Note``: In some cases you might need to restart edx-platform after installing the plugin to reflect the changes.
+* LMS
 
 Configurations
 --------------