docs: Update ecommerce docs

openedx · Mar 1, 2025 · feb76a3 · feb76a3
1 parent 388d628
commit feb76a3
Show file tree

Hide file tree

Showing 24 changed files with 69 additions and 6 deletions.
diff --git a/...ommerce/additional_features/apple_pay.rst → ...recated/additional_features/apple_pay.rst b/...ommerce/additional_features/apple_pay.rst → ...recated/additional_features/apple_pay.rst
diff --git a/...additional_features/change_processors.rst → ...additional_features/change_processors.rst b/...additional_features/change_processors.rst → ...additional_features/change_processors.rst
diff --git a/...ce/additional_features/gate_ecommerce.rst → ...ed/additional_features/gate_ecommerce.rst b/...ce/additional_features/gate_ecommerce.rst → ...ed/additional_features/gate_ecommerce.rst
diff --git a/...e/ecommerce/additional_features/index.rst → ...-deprecated/additional_features/index.rst b/...e/ecommerce/additional_features/index.rst → ...-deprecated/additional_features/index.rst
@@ -4,6 +4,9 @@
 Additional E-Commerce Features
 ################################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
 After you install the basic features of the E-Commerce service on your instance
 of the Open edX platform, you can enable or install additional features. You
 can set up E-Commerce to send email, switch payment processors, or track event

diff --git a/...dditional_features/maintain_ecommerce.rst → ...dditional_features/maintain_ecommerce.rst b/...dditional_features/maintain_ecommerce.rst → ...dditional_features/maintain_ecommerce.rst
diff --git a/...dditional_features/send_notifications.rst → ...dditional_features/send_notifications.rst b/...dditional_features/send_notifications.rst → ...dditional_features/send_notifications.rst
diff --git a/...mmerce/additional_features/track_data.rst → ...ecated/additional_features/track_data.rst b/...mmerce/additional_features/track_data.rst → ...ecated/additional_features/track_data.rst
diff --git a/...mmerce/create_products/create_coupons.rst → ...ecated/create_products/create_coupons.rst b/...mmerce/create_products/create_coupons.rst → ...ecated/create_products/create_coupons.rst
diff --git a/...e/create_products/create_course_seats.rst → ...d/create_products/create_course_seats.rst b/...e/create_products/create_course_seats.rst → ...d/create_products/create_course_seats.rst
diff --git a/...eate_products/create_enrollment_codes.rst → ...eate_products/create_enrollment_codes.rst b/...eate_products/create_enrollment_codes.rst → ...eate_products/create_enrollment_codes.rst
diff --git a/...ate_products/create_products_overview.rst → ...ate_products/create_products_overview.rst b/...ate_products/create_products_overview.rst → ...ate_products/create_products_overview.rst
diff --git a/...create_products/create_program_offers.rst → ...create_products/create_program_offers.rst b/...create_products/create_program_offers.rst → ...create_products/create_program_offers.rst
diff --git a/...merce/create_products/create_programs.rst → ...cated/create_products/create_programs.rst b/...merce/create_products/create_programs.rst → ...cated/create_products/create_programs.rst
diff --git a/...ource/ecommerce/create_products/index.rst → ...erce-deprecated/create_products/index.rst b/...ource/ecommerce/create_products/index.rst → ...erce-deprecated/create_products/index.rst
@@ -4,6 +4,9 @@
 Create E-Commerce Products
 ############################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
 After you :ref:`configure a partner and at least one site <Configure a Site
 Partner and Site Configuration>` for the E-Commerce service to use, and you
 have compiled and moved your static assests, you can create products. For more

diff --git a/.../source/ecommerce/enable_receipt_page.rst → ...mmerce-deprecated/enable_receipt_page.rst b/.../source/ecommerce/enable_receipt_page.rst → ...mmerce-deprecated/enable_receipt_page.rst
diff --git a/...all_operations/source/ecommerce/index.rst → ...ons/source/ecommerce-deprecated/index.rst b/...all_operations/source/ecommerce/index.rst → ...ons/source/ecommerce-deprecated/index.rst
@@ -1,11 +1,11 @@
-.. _Adding ECommerce to Open edX:
+.. _Adding ECommerce (Deprecated) to Open edX:
 
-##########################################
-Adding E-Commerce to the Open edX Platform
-##########################################
+#########################################################
+Adding E-Commerce (Derprecated) to the Open edX Platform
+#########################################################
 
 .. warning::
-   This service is under-maintained. We are not fixing bugs or developing new features for it. We hope to deprecate and replace it soon. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
 
 edX uses a Django application called ``ecommerce`` to provide the platform with
 ecommerce functionality. This `E-Commerce service`_ extends `Oscar`_, an open

diff --git a/...ns/source/ecommerce/install_ecommerce.rst → ...commerce-deprecated/install_ecommerce.rst b/...ns/source/ecommerce/install_ecommerce.rst → ...commerce-deprecated/install_ecommerce.rst
@@ -4,6 +4,9 @@
 Install and Start the E-Commerce Service
 ########################################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
 To install and start the edX E-Commerce service, you must complete the
 following steps.
 

diff --git a/...source/ecommerce/internationalization.rst → ...merce-deprecated/internationalization.rst b/...source/ecommerce/internationalization.rst → ...merce-deprecated/internationalization.rst
@@ -1,5 +1,10 @@
 Internationalization
 ====================
+
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
+
 Follow the `internationalization coding guidelines`_ in the edX Developer's Guide when developing new features.
 
 Languages are enabled in the settings file, for example in ``ecommerce/settings/base.py``

diff --git a/...ations/source/ecommerce/manage_assets.rst → ...ce/ecommerce-deprecated/manage_assets.rst b/...ations/source/ecommerce/manage_assets.rst → ...ce/ecommerce-deprecated/manage_assets.rst
@@ -4,6 +4,10 @@
 Manage Static Assets
 ##############################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
+
 After you :ref:`configure a partner and at least one site <Configure a Site
 Partner and Site Configuration>` for the E-Commerce system to use, you must
 compile all static assets and move them to the correct location to be served.

diff --git a/...ations/source/ecommerce/manage_orders.rst → ...ce/ecommerce-deprecated/manage_orders.rst b/...ations/source/ecommerce/manage_orders.rst → ...ce/ecommerce-deprecated/manage_orders.rst
@@ -4,6 +4,10 @@
 Manage Orders
 ##################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
+
 EdX has created a framework that manages order placement and fulfillment for
 digital products. Most of the products that edX supports involve modifications
 to enrollments.

diff --git a/...tions/source/ecommerce/test_ecommerce.rst → ...e/ecommerce-deprecated/test_ecommerce.rst b/...tions/source/ecommerce/test_ecommerce.rst → ...e/ecommerce-deprecated/test_ecommerce.rst
@@ -4,6 +4,10 @@
 Test Your E-Commerce Application
 ###################################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
+
 To test new applications that you develop for the E-Commerce service, you
 create and run tests for the Open edX platform first, and then you run a set of
 tests that are specific to E-Commerce.

diff --git a/...l_operations/source/ecommerce/theming.rst → ...s/source/ecommerce-deprecated/theming.rst b/...l_operations/source/ecommerce/theming.rst → ...s/source/ecommerce-deprecated/theming.rst
@@ -4,6 +4,10 @@
 Comprehensive Theming
 ######################
 
+.. warning::
+   This service is deprecated and was last tagged for the Redwood release. We are not fixing bugs or developing new features for it. For updates, `follow along on the DEPR ticket <https://github.com/openedx/public-engineering/issues/22>`_
+
+
 Any application, including Otto, can be loosely divided into two parts:
 
 * the user interface ("how it looks"), and

diff --git a/en_us/install_operations/source/ecommerce-solutions.rst b/en_us/install_operations/source/ecommerce-solutions.rst
@@ -0,0 +1,28 @@
+.. _Adding ECommerce to Open edX:
+
+Adding ECommerce to Open edX
+#############################
+
+This section is intended for those are who are building Open edX ecommerce
+solutions and customizing an Open edX installation to support their use.
+
+.. contents::
+   :local:
+   :depth: 1
+
+WooCommerce Plugin
+*******************
+
+There exists a WooCommerce plugin for the Open edX platform. See the following resources:
+
+* `WooCommerce Quickstart <https://edunext-docs-openedx-woocommerce-plugin.readthedocs-hosted.com/en/latest/plugin_quickstart.html#add-the-plugin-settings>`_
+* `WooCommerce plugin source <https://github.com/openedx/openedx-wordpress-ecommerce?tab=readme-ov-file#-open-edx-commerce-wordpress-plugin>`_
+
+Open edX Webhook Receiver
+*************************
+
+The `Open edX Webhook Receiver <https://github.com/hastexo/webhook-receiver?tab=readme-ov-file#openedx-webhook-receiver>`
+extension  is a small Django app that listens for incoming webhooks, and then
+translates those into calls against the Open edX REST APIs.
+
+As of Sumac it supports WooCommerce and Shopify endpoints.
diff --git a/en_us/install_operations/source/index.rst b/en_us/install_operations/source/index.rst
@@ -28,9 +28,14 @@ release.
    installation/index
    configuration/index
    insights/index
-   ecommerce/index
+   ecommerce-solutions
    mobile
    feature_flags/feature_flag_index
    glossary
 
+.. toctree::
+   :hidden:
+
+   ecommerce-deprecated/index
+
 .. include:: ../../links/links.rst