From feb76a382df0c283995da728c816a5dae3f86f1e Mon Sep 17 00:00:00 2001 From: sarina Date: Fri, 28 Feb 2025 19:01:47 -0500 Subject: [PATCH] docs: Update ecommerce docs --- .../additional_features/apple_pay.rst | 0 .../additional_features/change_processors.rst | 0 .../additional_features/gate_ecommerce.rst | 0 .../additional_features/index.rst | 3 ++ .../maintain_ecommerce.rst | 0 .../send_notifications.rst | 0 .../additional_features/track_data.rst | 0 .../create_products/create_coupons.rst | 0 .../create_products/create_course_seats.rst | 0 .../create_enrollment_codes.rst | 0 .../create_products_overview.rst | 0 .../create_products/create_program_offers.rst | 0 .../create_products/create_programs.rst | 0 .../create_products/index.rst | 3 ++ .../enable_receipt_page.rst | 0 .../index.rst | 10 +++---- .../install_ecommerce.rst | 3 ++ .../internationalization.rst | 5 ++++ .../manage_assets.rst | 4 +++ .../manage_orders.rst | 4 +++ .../test_ecommerce.rst | 4 +++ .../theming.rst | 4 +++ .../source/ecommerce-solutions.rst | 28 +++++++++++++++++++ en_us/install_operations/source/index.rst | 7 ++++- 24 files changed, 69 insertions(+), 6 deletions(-) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/apple_pay.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/change_processors.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/gate_ecommerce.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/index.rst (72%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/maintain_ecommerce.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/send_notifications.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/additional_features/track_data.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_coupons.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_course_seats.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_enrollment_codes.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_products_overview.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_program_offers.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/create_programs.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/create_products/index.rst (70%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/enable_receipt_page.rst (100%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/index.rst (74%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/install_ecommerce.rst (97%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/internationalization.rst (93%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/manage_assets.rst (86%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/manage_orders.rst (90%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/test_ecommerce.rst (98%) rename en_us/install_operations/source/{ecommerce => ecommerce-deprecated}/theming.rst (97%) create mode 100644 en_us/install_operations/source/ecommerce-solutions.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/apple_pay.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/apple_pay.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/apple_pay.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/apple_pay.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/change_processors.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/change_processors.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/change_processors.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/change_processors.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/gate_ecommerce.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/gate_ecommerce.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/gate_ecommerce.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/gate_ecommerce.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/index.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/index.rst similarity index 72% rename from en_us/install_operations/source/ecommerce/additional_features/index.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/index.rst index 715084a731..187af647ba 100644 --- a/en_us/install_operations/source/ecommerce/additional_features/index.rst +++ b/en_us/install_operations/source/ecommerce-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 `_ + 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/en_us/install_operations/source/ecommerce/additional_features/maintain_ecommerce.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/maintain_ecommerce.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/maintain_ecommerce.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/maintain_ecommerce.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/send_notifications.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/send_notifications.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/send_notifications.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/send_notifications.rst diff --git a/en_us/install_operations/source/ecommerce/additional_features/track_data.rst b/en_us/install_operations/source/ecommerce-deprecated/additional_features/track_data.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/additional_features/track_data.rst rename to en_us/install_operations/source/ecommerce-deprecated/additional_features/track_data.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_coupons.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_coupons.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_coupons.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_coupons.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_course_seats.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_course_seats.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_course_seats.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_course_seats.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_enrollment_codes.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_enrollment_codes.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_enrollment_codes.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_enrollment_codes.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_products_overview.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_products_overview.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_products_overview.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_products_overview.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_program_offers.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_program_offers.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_program_offers.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_program_offers.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/create_programs.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/create_programs.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/create_products/create_programs.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/create_programs.rst diff --git a/en_us/install_operations/source/ecommerce/create_products/index.rst b/en_us/install_operations/source/ecommerce-deprecated/create_products/index.rst similarity index 70% rename from en_us/install_operations/source/ecommerce/create_products/index.rst rename to en_us/install_operations/source/ecommerce-deprecated/create_products/index.rst index aec9e82aac..51fb5c67fb 100644 --- a/en_us/install_operations/source/ecommerce/create_products/index.rst +++ b/en_us/install_operations/source/ecommerce-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 `_ + After you :ref:`configure a partner and at least one site ` 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/en_us/install_operations/source/ecommerce/enable_receipt_page.rst b/en_us/install_operations/source/ecommerce-deprecated/enable_receipt_page.rst similarity index 100% rename from en_us/install_operations/source/ecommerce/enable_receipt_page.rst rename to en_us/install_operations/source/ecommerce-deprecated/enable_receipt_page.rst diff --git a/en_us/install_operations/source/ecommerce/index.rst b/en_us/install_operations/source/ecommerce-deprecated/index.rst similarity index 74% rename from en_us/install_operations/source/ecommerce/index.rst rename to en_us/install_operations/source/ecommerce-deprecated/index.rst index f56f16756e..98189a56f2 100644 --- a/en_us/install_operations/source/ecommerce/index.rst +++ b/en_us/install_operations/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 `_ + 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 `_ 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/en_us/install_operations/source/ecommerce/install_ecommerce.rst b/en_us/install_operations/source/ecommerce-deprecated/install_ecommerce.rst similarity index 97% rename from en_us/install_operations/source/ecommerce/install_ecommerce.rst rename to en_us/install_operations/source/ecommerce-deprecated/install_ecommerce.rst index 70510c400d..1fd91f5be0 100644 --- a/en_us/install_operations/source/ecommerce/install_ecommerce.rst +++ b/en_us/install_operations/source/ecommerce-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 `_ + To install and start the edX E-Commerce service, you must complete the following steps. diff --git a/en_us/install_operations/source/ecommerce/internationalization.rst b/en_us/install_operations/source/ecommerce-deprecated/internationalization.rst similarity index 93% rename from en_us/install_operations/source/ecommerce/internationalization.rst rename to en_us/install_operations/source/ecommerce-deprecated/internationalization.rst index f331e66ef5..4a8f85e3d3 100644 --- a/en_us/install_operations/source/ecommerce/internationalization.rst +++ b/en_us/install_operations/source/ecommerce-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 `_ + + 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/en_us/install_operations/source/ecommerce/manage_assets.rst b/en_us/install_operations/source/ecommerce-deprecated/manage_assets.rst similarity index 86% rename from en_us/install_operations/source/ecommerce/manage_assets.rst rename to en_us/install_operations/source/ecommerce-deprecated/manage_assets.rst index 37c4cb4cd7..64884cc1bb 100644 --- a/en_us/install_operations/source/ecommerce/manage_assets.rst +++ b/en_us/install_operations/source/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 `_ + + After you :ref:`configure a partner and at least one site ` 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/en_us/install_operations/source/ecommerce/manage_orders.rst b/en_us/install_operations/source/ecommerce-deprecated/manage_orders.rst similarity index 90% rename from en_us/install_operations/source/ecommerce/manage_orders.rst rename to en_us/install_operations/source/ecommerce-deprecated/manage_orders.rst index cba7a2d0c0..1d16f12125 100644 --- a/en_us/install_operations/source/ecommerce/manage_orders.rst +++ b/en_us/install_operations/source/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 `_ + + 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/en_us/install_operations/source/ecommerce/test_ecommerce.rst b/en_us/install_operations/source/ecommerce-deprecated/test_ecommerce.rst similarity index 98% rename from en_us/install_operations/source/ecommerce/test_ecommerce.rst rename to en_us/install_operations/source/ecommerce-deprecated/test_ecommerce.rst index 1f967aa05a..b43ae24dfe 100644 --- a/en_us/install_operations/source/ecommerce/test_ecommerce.rst +++ b/en_us/install_operations/source/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 `_ + + 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/en_us/install_operations/source/ecommerce/theming.rst b/en_us/install_operations/source/ecommerce-deprecated/theming.rst similarity index 97% rename from en_us/install_operations/source/ecommerce/theming.rst rename to en_us/install_operations/source/ecommerce-deprecated/theming.rst index 40578256b0..48743944ab 100644 --- a/en_us/install_operations/source/ecommerce/theming.rst +++ b/en_us/install_operations/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 `_ + + 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 new file mode 100644 index 0000000000..b1da6f473e --- /dev/null +++ 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 `_ +* `WooCommerce plugin source `_ + +Open edX Webhook Receiver +************************* + +The `Open edX 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. \ No newline at end of file diff --git a/en_us/install_operations/source/index.rst b/en_us/install_operations/source/index.rst index 78784592ed..0691161d87 100755 --- 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